On Tuesday 15 June 2010 14:07:11 Tim Vandermeersch wrote: > On Tue, Jun 15, 2010 at 7:25 PM, Craig A. James <[email protected]> wrote: > > On 6/15/10 10:12 AM, Geoffrey Hutchison wrote: > >> I think there are two classes of documentation: > >> 1) Developer-level docs (e.g., tutorials, API, etc.). > >> > >> 2) User-level tutorials. > > > > Right, I agree with Geoff. My comments about in-line documentation are > > only applicable to API and class descriptions, and doxygen (or something > > similar) is the key to success. But user-level tutorials always have to > > be done separately. > > It's not my intention to remove user documentation. But user > documentation in a repository would be easier to maintain. Like I > said, the format can be wiki pages. > There are generators such as asciidoc which we are starting to experiment with. Friendly to version control, simple and readable raw syntax with multiple backend. One of the new projects I am working on at Kitware is using Doxygen for the API docs and some inline documentation, and we are seriously considering alternatives such as asciidoc for user oriented documentation/a book.
Marcus ------------------------------------------------------------------------------ ThinkGeek and WIRED's GeekDad team up for the Ultimate GeekDad Father's Day Giveaway. ONE MASSIVE PRIZE to the lucky parental unit. See the prize list and enter to win: http://p.sf.net/sfu/thinkgeek-promo _______________________________________________ OpenBabel-Devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/openbabel-devel
