Results 1 to 4 of 4

Thread: ClanLib 0.9 API documentation file format

  1. #1
    ClanLib Developer
    Join Date
    May 2007
    Posts
    1,824

    Default ClanLib 0.9 API documentation file format

    I have had a look at tidying up the API header file.

    See Attached File

    (The output from ReferenceDocs and Doxygen should be the same)

    If you want to try it out, ClanLib-0.9/Documentation/Reference/clanlib.doxygen will need modification:

    ALWAYS_DETAILED_SEC = YES
    MULTILINE_CPP_IS_BRIEF = NO
    OPTIMIZE_OUTPUT_FOR_C = YES

    Attached Files Attached Files

  2. #2
    ClanLib Developer
    Join Date
    Sep 2006
    Location
    Denmark
    Posts
    554

    Default

    Seems okay to me, although I personally prefer /// over //! for documentation lines.

    Did you manually clean it up like this or is it some shell script you are going to run on all the headers?

  3. #3
    ClanLib Developer
    Join Date
    May 2007
    Posts
    1,824

    Default

    I did that manually, but for the rest, I would write a script.

    I would also prefer "///", i did not know that doxygen accepted that format.

    I'll have a look tomorrow.

  4. #4
    ClanLib Developer
    Join Date
    May 2007
    Posts
    1,824

    Default

    All done

    That was difficult and tedious! :wheelchair:

Similar Threads

  1. How to Build Clanlib documentation on FreeBSD?
    By NVanGogh in forum Official ClanLib SDK Forums
    Replies: 1
    Last Post: 08-13-2008, 11:04 PM
  2. Misleading documentation
    By SnT2k in forum Official ClanLib SDK Forums
    Replies: 0
    Last Post: 11-03-2007, 02:43 AM
  3. Documentation
    By Caesar in forum Official ClanLib SDK Forums
    Replies: 1
    Last Post: 08-09-2007, 08:42 PM
  4. Documentation bug: please include OSX equivalents to hotkeys
    By whisperstorm in forum Novashell Game Creation System
    Replies: 2
    Last Post: 01-13-2007, 03:55 AM
  5. Generating documentation
    By TauCeti in forum Official ClanLib SDK Forums
    Replies: 1
    Last Post: 10-30-2006, 01:55 PM

Bookmarks

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
  •