Changes between Version 23 and Version 24 of NaturalDocs

Show
Ignore:
Timestamp:
06/29/11 16:38:28 (23 months ago)
Author:
tschaub
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • NaturalDocs

    v23 v24  
    33[[PageOutline]] 
    44 
    5 !OpenLayers API documentation is build with [http://www.naturaldocs.org/ Natural Docs].  This documentation is built with the following 
     5!OpenLayers API documentation is build with [http://www.naturaldocs.org/ Natural Docs].  There are two "profiles" for our documentation, API and API+non-API (all).  To build just the docs for the public API, run the following: 
     6{{{ 
     7NaturalDocs -i lib -o HTML apidoc -p apidoc_config -s Default OL 
     8}}} 
     9To build docs for the public API plus the "private" methods/properties, run the following: 
    610{{{ 
    711NaturalDocs -i lib -o HTML doc -p doc_config -s Default OL 
    812}}} 
     13Run this from the root of your http://svn.openlayers.org/trunk/openlayers checkout.  The first will build a site in the {{{apidoc}}} folder, the second will build a site in the {{{doc}}} folder. 
    914 
    1015There are a number of conventions we need to adopt in our coding in order to make the output documentation more useful.  The following is a rough list, meant to be refined as we go.