Results 1 to 5 of 5

Thread: Automatic document creation (like Doxygen)

  1. #1

    Automatic document creation (like Doxygen)

    I found PasDoc that works like Doxygen. Do you know some other tools that can generate documents out of Pascal code?

  2. #2
    Legendary Member cairnswm's Avatar
    Join Date
    Nov 2002
    Location
    Randburg, South Africa
    Posts
    1,537

    Automatic document creation (like Doxygen)

    I have a slightly modified version of PasDoc I use. (The source is available and I got permission from the author to modify as I wanted)

    Unfortunatly it occasionally throws exceptions like when there is no file open in the editor.
    William Cairns
    My Games: http://www.cairnsgames.co.za (Currently very inactive)
    MyOnline Games: http://TheGameDeveloper.co.za (Currently very inactive)

  3. #3

    Automatic document creation (like Doxygen)

    We write the Free Pascal documentation with FPDoc. The biggest difference with Pasdoc is that FPDoc builds the documentation using a combination of source code and documentation files, while Pasdoc reads documentation from comments.

    The FPDoc approach has turned out to be supperior for us, because if you put all the documentation in comments ultimately it gets "in the way" , because the documentation is very verbose.

  4. #4

    Automatic document creation (like Doxygen)

    I'm using the latest SVN version of PasDoc and it works quite fine for my needs.

    @dmantione
    I also noticed that comments are getting bigger and bigger when using PasDoc with functions that require lot of text. Can you point me to some article that explains how to create description file for FPDoc?

    Edit: Found how to use FPDoc... makeskel creates empty desc. file and I fill it (LazDoc seems like nice tool for filling desc. text).

  5. #5

    Automatic document creation (like Doxygen)

    Yes, that's the approach

Bookmarks

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  
Comodo SSL