#7 JavaDoc

closed
None
5
2003-11-05
2003-09-30
No

Hi,

Will JavaDoc style documentation be supported too?
Currently this style is used in the ZeosLib components,
and I would like to use Pas2Dox to convert this to
DoxyGen.

Kind regards,

Maarten Bremer

Discussion

  • Maarten Bremer

    Maarten Bremer - 2003-09-30

    Logged In: YES
    user_id=654190

    I mean like this:

    {// Comments
    And more comments
    }

     
  • Darren Bowles

    Darren Bowles - 2003-10-02

    Logged In: YES
    user_id=73730

    JavaDoc comments are supported by Doxygen. If you have a
    look at the documenting the code section in the Doxygen
    help, that has some examples.

    Pas2Dox will convert { or (* to /* and } or *) to */

    Ie. {// Comments
    and more comments
    }

    would be presented to Doxygen as

    /*//Comments
    and more comments
    */

    Just had a quick look at the Doxygen examples myself.
    Maybe you could do something like

    {! comments
    \param some parameter
    \return some results
    }

     
  • Darren Bowles

    Darren Bowles - 2003-10-03

    Logged In: YES
    user_id=73730

    I had a look at some of your code and you're using the
    following style

    {**
    brief description
    @param object some desc
    }

    This will get presented as

    /***
    brief description
    @param object some desc
    */

    I take it that your code isn't getting converted correctly,
    maybe because of the additional *. I could add a command
    line option in to handle this type of commenting if you don't
    want to change your source code.

     
  • Maarten Bremer

    Maarten Bremer - 2003-10-03

    Logged In: YES
    user_id=654190

    Yes, I am very sorry for all the confusment. The {** are
    indeed not converted correctly in DoxyGen. If you could add a
    command line option, that would be very great. Thanks for
    your help!

     
  • Darren Bowles

    Darren Bowles - 2003-10-03

    Logged In: YES
    user_id=73730

    Can you confirm that things work ok with Just one * in your
    comments.

    All I will do then, is if new command line parameter is enabled,
    when converting {, instead of becoming /* it will just
    become /

     
  • Maarten Bremer

    Maarten Bremer - 2003-10-03

    Logged In: YES
    user_id=654190

    Wouldn't it be a nicer option to convert both '{**', '{*'
    and '{' to '/*'? In that case it won't break if the DoxyGen
    style is used instead of the JavaDoc style. Please tell me if
    I'm wrong, because this is the very first time I am using
    DoxyGen.

     
  • Darren Bowles

    Darren Bowles - 2003-10-06

    Logged In: YES
    user_id=73730

    New -j command line option in forthcoming version, will
    convert {** to /**, which will mean that you won't have to
    change your commenting style.

    Not sure that we would need to convert {* to /*, how are
    you using this in your code?

     
  • Darren Bowles

    Darren Bowles - 2003-10-06
    • assigned_to: nobody --> dbowles
     
  • Darren Bowles

    Darren Bowles - 2003-11-05

    Logged In: YES
    user_id=73730

    Sorry it's been some time..., both my home and work PC's
    have had to be rebuilt, so I've lost the emails we exchanged
    on this subject...

    I've got the -j option checked into CVS tonight. If you see
    anything different, give me a shout and i'll sort it out.

     
  • Darren Bowles

    Darren Bowles - 2003-11-05
    • status: open --> closed
     

Log in to post a comment.

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:





No, thanks