Opened 9 years ago

Closed 9 years ago

#33 closed task (fixed)

Add NaturalDocs configuration

Reported by: ahocevar Owned by:
Priority: major Milestone: 0.5
Component: documentation Version:
Keywords: Cc:
State: Commit

Description

Add apidoc_config for NaturalDocs.

The attached patch provides a customized Topics.txt and apidoc_config directory for NaturalDocs 1.4, along with some changes to existing trunk ND comments to make them look good.

NaturalDocs is supposed to be run from the build directory with the following command:

$ NaturalDocs -i ../lib -o HTML ../doc -p apidoc_config

Attachments (1)

naturaldocs.patch (14.4 KB) - added by ahocevar 9 years ago.
NaturalDocs configuration which also gives us nice keywords like XType and Node Type

Download all attachments as: .zip

Change History (4)

Changed 9 years ago by ahocevar

NaturalDocs configuration which also gives us nice keywords like XType and Node Type

comment:1 Changed 9 years ago by ahocevar

  • Milestone set to 0.1
  • Priority changed from blocker to major
  • State changed from None to Review

comment:2 Changed 9 years ago by tschaub

  • State changed from Review to Commit

Looks good Andreas. I say we take future doc and doc config commits for free. Thanks for the config updates.

comment:3 Changed 9 years ago by ahocevar

  • Resolution set to fixed
  • Status changed from new to closed

(In [302]) added apidoc_config folder with initial NaturalDocs configuration. Also modified ND comments in some js files to produce nice output (closes #33)

Note: See TracTickets for help on using tickets.