Ideas

From GNUstepWiki
Revision as of 20:46, 26 February 2005 by Stefan Urbanek (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

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.