Ideas

From GNUstepWiki

(Difference between revisions)
Revision as of 20:46, 26 February 2005
Stefan Urbanek (Talk | contribs)

← Previous diff
Revision as of 20:46, 26 February 2005
Stefan Urbanek (Talk | contribs)
Autogsdoc and wiki syntax
Next diff →
Line 3: Line 3:
The class documentation should have simpler syntax than XML. For example a wiki-like syntax, where references would be enclosed in <nowiki>[[ and ]] for the ObjectiveC message sends, one should prefix the first [ by a backslash. Like: \[[alloc] init]</nowiki>. The class documentation should have simpler syntax than XML. For example a wiki-like syntax, where references would be enclosed in <nowiki>[[ and ]] for the ObjectiveC message sends, one should prefix the first [ by a backslash. Like: \[[alloc] init]</nowiki>.
-<nowki>Italics should be marked by ''italics'', bold by '''bold''' (mediawiki) or by __bold__ (phpwiki)</nowiki>+<nowiki>Italics should be marked by ''italics'', bold by '''bold''' (mediawiki) or by __bold__ (phpwiki)</nowiki>
<nowiki> The references should be: [[Class:class_name]], [[Method:Class:methodName:]], [[ivar:ivarname]]</nowiki> <nowiki> The references should be: [[Class:class_name]], [[Method:Class:methodName:]], [[ivar:ivarname]]</nowiki>
XML is a bit complicated for such simple task as documentation. XML is a bit complicated for such simple task as documentation.

Revision as of 20:46, 26 February 2005

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].

Italics should be marked by ''italics'', bold by '''bold''' (mediawiki) or by __bold__ (phpwiki)

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

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