Feature Request #1002

TTObject Reference Generation

Added by Tim Place almost 6 years ago. Updated over 4 years ago.

Status:ClosedStart date:2011-10-21
Priority:NormalDue date:
Assignee:-% Done:

0%

Category:-Spent time:-
Target version:(Jamoma Platform) - Max6 sprint
Branch:

Description

We need to generate YML (or other formats) of reference documentation. Most of the objects in Jamoma are wrappers around TTObjects, so... a mechanism should be created that queries the TTClasses to generate documentation.

  • Class descriptions (and digest) go in another #Define at the top of the class, and get shoved into the class registry.
  • Descriptions for messages and attributes can be done with attribute properties and message properties.
  • See Also can be generated by using the tags.

Further specifications:

  • The description string for the attrs should be included in the addAttribute macro because we otherwise clutter the code.
  • Could also add information about where the class is used (from a file traversal of jamoma modules, for example)

Related issues

Related to Modular - Feature Request #243: adding tags to components modules Rejected 2009-08-03
Related to DSP - Bug #637: filterLib : description for all those filters Closed 2010-11-18

History

#1 Updated by Tim Place almost 6 years ago

  • Project changed from Plugtastic to (Jamoma Platform)

#2 Updated by Nils Peters almost 6 years ago

  • Target version set to Max6 sprint

#3 Updated by Trond Lossius over 4 years ago

  • Project changed from (Jamoma Platform) to Max

#4 Updated by Trond Lossius over 4 years ago

  • Status changed from New to Closed

The issues are being moved to GitHub issue tracker

Also available in: Atom PDF