Search code examples
doxygencaplcanoe

Using doxygen with CAPL (CANoe)

i am currently working with CAPL (CANoe) and was wondering, if there is a way to use doxygen to document my CAPL-code. I have used doxygen before, on a project working with C++ and was very happy with it.

I have found something that sounds very promising (https://github.com/BretislavRychta/CAPL-filter-for-Doxygen), but unfortunately I can't get it to work.

If someone could tell me how to make it work, or give me an alternative solution to document my CAPL code (using doxygen or something else), I would be very happy :)

Here is an example of the CAPL Code:

on start
{
  write("Started!");
  set_id();
  version_proposal();
}

void set_id()
{
  msg_test.id = node_number;
  msg_test.dlc = msg_dlc;

  msg_test.can = 1;
}

I edited the Doxyfile, with the changes recommended, and I'm also having Trouble with the INPUT_FILTER.... I tried it in the following way, which I think is right, and in some other variations, but it isn't working.

INPUT_FILTER           = "perl C:\Users\gerdes\Desktop\Doxygen Test\capl_filer.pl"
Solution

  • The, minimal, description at https://github.com/BretislavRychta/CAPL-filter-for-Doxygen is for Linux and similar systems. For Windows there is a small change required.

    INPUT_FILTER = capl_filter.pl

    works OK for Linux due to the possibility to automatically start the perl file. On windows we need:

    INPUT_FILTER = "perl <path_to>/capl_filter.pl"

    in case '' we need:

    INPUT_FILTER = "perl \"<path_to>/capl_filter.pl\""