GNUStep Documentation– General Improvements

[BTS]

There are a number of things that concern me about the manner in which
GNUStep is doccumented.

1. The first of which is that in order to find the pages containing the
information generated by autogsdoc one has to scoure the site, even though
reference documentation should be easy to find.  A link to the reference
documentation shouuld appear on the main page instead of a link on a page
form the sidebar at the bottom on the wiki page.

2. GNUStep uses it's own proprietary documentation genrator when perfectly
good Objective-C document generators such as Doxygene are available, and
also produce less bland more readably, clean and easily navigatable
documentation.  These doccument generators also have multiple output
formats.

3.  Required delegate methods should be indicated by differently colored
headers and anchor links.

4.  The example program page does not contain the sample code from the
sample programs, only their .app packages, this is generally a good demo,
but not helpful from a prgramming prespective.

5.  The GNUStep documentation does not reference sample code– even
referencing apple sample code would be useful, though optimally apple sample
code should be tested using GS APIs

If you agree and think things should change or you think I am in error feel
free to post your thoughts.  Making documentation easily readible, and
providing useful samples should be a priority in order to attract
developpers to the GNUStep platform.
-- 
View this message in context: 
http://old.nabble.com/GNUStep-Documentation%E2%80%93-General-Improvements-tp32394188p32394188.html
Sent from the GNUstep - General mailing list archive at Nabble.com.