OpenLayers OpenLayers

Ticket #773 (closed feature: fixed)

Opened 1 year ago

Last modified 9 months ago

convert comment style to Natural Docs style

Reported by: tschaub Assigned to:
Priority: minor Milestone: 2.5 Release
Component: general Version: 2.4
Keywords: Cc:
State:

Description

Natural Docs provides a nice, comment-only way for us to document our code.

I've set up a sandbox to make these changes.

Documentation is built with 

NaturalDocs -i lib -o HTML doc -p doc_config -s Small OL

and the output can be seen in the doc dir of the sandbox.

Natural Docs doesn't handle everything we want in our documentation - though I'm already convinced we can configure it to work.

I've set up a Natural Docs page to keep track of code documentation conventions.

Change History

06/25/07 23:43:27 changed by euzuro

Of possible interest to this mission, as mentioned by Cameron S. on the dev list:

http://www.naturaldocs.org/documentation/development/files/Modules/NaturalDocs/Parser/JavaDoc-pm.html

(A tool that autoconverts JavaDoc to NaturalDoc)

10/10/07 01:12:02 changed by crschmidt

  • status changed from new to closed.
  • resolution set to fixed.
  • milestone set to 2.5 Release.

Fixed in 2.5.