Menu

Newbie: Problem using CAPL generated code

Dav
2012-08-02
2015-10-26
  • Dav

    Dav - 2012-08-02

    The CAPL tool generates C type code so we can generate most docs for our files. The problem occurs when it generates the included files as follows

    includes
    {
    #include "TestCode.cin"
    }

    The problem is that Doxygen outputs

    #include "TestCode.cin"
    in the output file. But ignores everything else. If we take out the "includes {" and its corresponding "}" by hand, Doxygen seems to have visibilty to the rest of the code and generates the documentation correctly.

    The same thing happens when the CAPL tool generates

    variables
    {

    }

    It just doesn't see anything else in the CAPL generated code. Background info CAPL tool generates C type files with its own annotations that Doxygen may not recognize.

    Any help for this Newbie would be highly appreciated. Thank you.

     
  • Jens Arpe

    Jens Arpe - 2013-09-18

    Hey,

    I had exactly the same problem. I didn't find a real solution, but a little workaround.

    Add

    /*
    @manonly
    /

    before then "include"-block and

    /*
    @endmanonly
    /

    after the "variables"-block

    You will get some warnings from doxygen, and it can't access the "include"- and "variables"-block, but the rest of the code will become visible to it.

    Edit: I just saw, that the forum makes whatever with my comment blocks. So just include the @manonly and @endmanoly in a normal comment block.

     

    Last edit: Jens Arpe 2013-09-18
  • Stefan Lutzenberger

    Hi here,

    I alls started to document my CAPL code with doxygen!
    The topic here helps me to start.
    Thanks a lot.

    At the moment I have only one problem with the document of events!
    Has maybe someone of you a workaround for document the events?

    in CAPL a event looks like this:

    on preStart
    {

    }

    or

    on sysvar NewSysvar
    {

    }

    starts always with a on

    if I try this its not working:

    //----------------------------------------------------------------------------------------
    /*!\fn on preStart
    \brief Event preStart

                  Event occur then start button is pressed
    

    \created 15.10.2013

    \internal
    */
    //----------------------------------------------------------------------------------------

    I think because where is no () inside!!!!!!!!!!!!!!!!!!!!!

    Can somebody help?

    P.S:
    important maybe for other newbies in the Doxyfile.dox

    EXTENSION_MAPPING cin=C can=C

    FILE_PATTERNS add .cin .can

     
  • shen sol

    shen sol - 2020-11-15
    Post awaiting moderation.

Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.