Announcement

Collapse
No announcement yet.

API Documentation Generator

Collapse
X
 
  • Filter
  • Time
  • Show
Clear All
new posts

    API Documentation Generator

    Hey everybody,

    I've been needing a API documentation generator for our Miva code. Does anyone know of one that've been using? I know Miva is using doxygen, but I'm hoping to find something that will parse Miva as is instead of having to instruct it to do it a certain way. Anyone have something in the works or know of something that could be leveraged to accomplish this? I've been thinking of using a python or php doc generator as starting point for this, but I thought I'd reach out to the community for any additional ideas.

    #2
    Re: API Documentation Generator

    Many moons ago I wrote a perl script that would read through a list of .mv files, pull out all the function calls along with all the parameters and put them into an xml file. I then slapped an xslt to it so that it looks important (readable).

    If you really want to get fancy, you can put a specially formatted MvCOMMENT inside a function that would contain more information similar to PHPDoc and JavaDoc. This would allow you to put in descriptions, references to other files/functions, and mark a function as "deprecated".

    I built it 1) as a quick way to create documentation, and 2) as a way to learn some perl. Because of part two, the code could likely use a lot of optimization but it will run.

    If there is any interest, I'll post the .pl and .xslt files here.

    Comment

    Working...
    X