On Wed, Feb 26, 2014 at 6:29 AM, Doug Franklin
<nutdriverle...@comcast.net>wrote:

> So, I'm kinda late to the party, since I only started using Fossil a year
> ago, or so.  But, I'd like to throw out a suggestion: something like
> doxygen or javadoc so that the documentation and source are the same
> artifact.  Knuth tried with tangle/weave, but maybe it's time to revisit
> the concept?
>

That doesn't quite apply in this particular case. The C-level library APIs
are indeed doxygen format directly in the header files, but the scripting
engine has no native doc format (and there are no plans to extend it with
one), so those docs are written/formatted "by hand" using whatever tool
fits with the least amount of effort (==>Google Docs). Also note that this
is a distinctly different topic from fossil(1) (the core fossil app). Its
help text/documentation is generated by tools which scan the C sources for
certain custom markup, then compiles in a copy of the text found there.

The C-level API docs:

http://fossil.wanderinghorse.net/repos/libfossil/doxygen/

-- 
----- stephan beal
http://wanderinghorse.net/home/stephan/
http://gplus.to/sgbeal
"Freedom is sloppy. But since tyranny's the only guaranteed byproduct of
those who insist on a perfect world, freedom will have to do." -- Bigby Wolf
_______________________________________________
fossil-users mailing list
fossil-users@lists.fossil-scm.org
http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users

Reply via email to