From ... Path: archiver1.google.com!newsfeed.google.com!newsfeed.stanford.edu!news.tele.dk!134.222.94.5!npeer.kpnqwest.net!nreader1.kpnqwest.net.POSTED!not-for-mail Newsgroups: comp.lang.lisp Subject: Re: So, where's the "Javadoc" for COMMON Lisp? References: <3B544F2D.2D2B5B99@rchland.vnet.ibm.com> <9j20j2$ifl$2@newsg1.svr.pol.co.uk> <3204451328338331@naggum.net> Mail-Copies-To: never From: Erik Naggum Message-ID: <3204459709990624@naggum.net> Organization: Naggum Software, Oslo, Norway Lines: 32 User-Agent: Gnus/5.0808 (Gnus v5.8.8) Emacs/20.7 MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Date: Wed, 18 Jul 2001 15:41:51 GMT X-Complaints-To: newsmaster@Norway.EU.net X-Trace: nreader1.kpnqwest.net 995470911 193.71.66.1 (Wed, 18 Jul 2001 17:41:51 MET DST) NNTP-Posting-Date: Wed, 18 Jul 2001 17:41:51 MET DST Xref: archiver1.google.com comp.lang.lisp:13312 * Kent M Pitman > (Why just those and not even user-defined symbols?) Primarily because they would be in "sealed" packages with their external specification and documentation, anyway. It would be a waste to keep a watered-down version in documentation strings. * Marco Antoniotti > However, I would not discard the idea of a Document Generator. I like to > have "clean" doc strings in lieu of comments. I think there is something to be said for a low-cost documentation like a simple string. As I expect more from the specification in the HyperSpec and I expect more from vendor documentation, I expect that documentation for code in development _not_ be polished and indexed and everything web pages, but rather something that is so easy to write well and maintain at a high quality that it does not seem like the drag that documentation so often is considered to be. I also personally prefer to leave the quality publication job to people who are good at it, instead of me trying to to something I both dislike and feel inept at. One of the reasons I do not write a lot of web pages is that I have tremendous respect for typography and nearly everything I do with that abominable HTML thing really sucks -- much less than most of what is out there on the "web", but it still looks mostly awful and screams incompetence. Although not only and not necessarily mine, I still get blamed for how it looks. I would much rather publish something in PDF than that hot toy markup language. #:Erik -- There is nothing in this message that under normal circumstances should cause Barry Margolin to announce his moral superiority over others, but one never knows how he needs to behave to maintain his belief in it.