Flows - Generating Documentation with Doxygen | man of many distractions....

paulbhartzog's picture
Posted Fri, 06/26/2009 - 11:21 by paulbhartzog
url: 

http://paulbhartzog.org/2009/06/25/flows-generating-documentation-doxygen

Today I successfully generated some documentation directly from commented Flows code in both php and python, and I also found that Doxygen ought to work with Ruby (we'll see). In a Flows-like way, Doxygen generates the documentation in XML, HTML, RTF, etc.

I learned enough about the process though to realize that it might be smarter to write a Flows component that generates the documentation you need when you are looking at it in the browser, instead of pre-generating static files of documentation.

Will have to contemplate....

Comments

Sam Rose's picture

This is a great idea.

by Sam Rose - 06/26/2009 - 21:17

This is a great idea. Especially since it is already available via the SIP. We could skip doxygen and complexity, and just rely on the information that is already available. it could be converted on the fly as you say. That is brilliant, and possibly does not require anything more than what is already in spec

Post new comment

  • Web page addresses and e-mail addresses turn into links automatically.
  • Allowed HTML tags: <a> <em> <strong> <cite> <code> <ul> <ol> <li> <dl> <dt> <dd><blockquote>
  • Lines and paragraphs break automatically.
  • Link to content with [[some text]], where "some text" is the title of existing content or the title of a new piece of content to create. You can also link text to a different title by using [[link to this title|show this text]]. Link to outside URLs with [[http://www.example.com|some text]], or even [[http://www.example.com]].
  • You can enable syntax highlighting of source code with the following tags: <code>, <blockcode>, <c>, <c++>, <d5>, <d6>, <java>, <js>, <mxml>, <mysql>, <perl>, <php>, <python>, <rails>, <ruby>, <xml>. Beside the tag style "<foo>" it is also possible to use "[foo]".

More information about formatting options

CAPTCHA
This question is for testing whether you are a human visitor and to prevent automated spam submissions.
Image CAPTCHA
Copy the characters (respecting upper/lower case) from the image.