Ideas

From GNUstepWiki

Revision as of 20:46, 26 February 2005; view current revision
←Older revision | Newer revision→

Autogsdoc and wiki syntax

The class documentation should have simpler syntax than XML. For example a wiki-like syntax, where references would be enclosed in [[ and ]] for the ObjectiveC message sends, one should prefix the first [ by a backslash. Like: \[[alloc] init].

<nowki>Italics should be marked by italics, bold by bold (mediawiki) or by __bold__ (phpwiki)</nowiki>

The references should be: [[Class:class_name]], [[Method:Class:methodName:]], [[ivar:ivarname]]

XML is a bit complicated for such simple task as documentation.