Re: Opinions about API documentation

2000-08-09 Thread Rodent of Unusual Size
Julia Pond wrote: > > You could describe the SERVER_* constants separately *and* list them > under the scoreboard entry, if you wanted to. People might search on > "scoreboard", and it would be handy to get all pertinent info there. Even if they have separate entries, they're still listed in the

Re: Opinions about API documentation

2000-08-09 Thread Julia Pond
Definitely, keep them separate, that's a good standard for usability. Unique TOC entries & quick navigation to the topic is important. You could describe the SERVER_* constants separately *and* list them under the scoreboard entry, if you wanted to. People might search on "scoreboard", and it woul

Opinions about API documentation

2000-08-09 Thread Rodent of Unusual Size
I'm writing a bunch of the 1.3 API documentation pieces, and so far I've been treating each identifier separately. That is, there's a separate entry for each of HTTP_OK, HTTP_METHOD_NOT_ALLOWED, and HTTP_CONTINUE, and separate entries for SERVER_DEAD, SERVER_BUSY, and SERVER_STARTING. The question