OpenLayers OpenLayers

Ticket #1229 (closed bug: fixed)

Opened 1 year ago

Last modified 2 months ago

new version of NaturalDocs requires jsdoc style declarations to be in a separate block

Reported by: tschaub Assigned to:
Priority: minor Milestone: 2.6 Release
Component: documentation Version: 2.5
Keywords: Cc:
State: Complete

Description (Last modified by euzuro)

Instead of 

/**
 * @requires Dependency
 *
 * Class: Name
 * Whatever
 */

we have to start doing something like 

/**
 * @requires Dependency
 */

/**
 * Class: Name
 * Whatever
 */

With the new (dev) version of NaturalDocs, the former style excludes the documentation from the docs (so none of our docs have class descriptions, links to superclasses, etc).

Change History

12/21/07 03:28:09 changed by tschaub

  • status changed from new to closed.
  • state set to Complete.
  • resolution set to fixed.

(In [5553]) Separating jsdoc style docs into their own block. The new NaturalDocs doesn't parse these mixed blocks, giving us no class descriptions with the two together. (closes #1229)

(follow-up: ↓ 3 ) 01/09/08 11:47:58 changed by euzuro

  • description changed.

based on what i see in the changeset, i think this is what tim meant.

(in reply to: ↑ 2 ) 01/09/08 11:58:15 changed by tschaub

Replying to euzuro:

based on what i see in the changeset, i think this is what tim meant.

You are correct sir. Thanks for fixing my typos.

03/04/08 05:11:32 changed by fredj

(In [6431]) Separating jsdoc declarations. (See #1229)

10/10/08 08:36:31 changed by fredj

(In [8102]) Separating jsdoc declarations. (See #1229)