taskSavannah Administration - Tasks: task #9789, Submission of MkDoc C/C++...

 
 

task #9789: Submission of MkDoc C/C++ documentation tool

Submitter:  Alexandre Becoulet <diaxen>
Submitted:  Tue 13 Oct 2009 02:43:38 PM UTC
   
 
Should Start On:  Mon 12 Oct 2009 10:00:00 PM UTC Should be Finished on:  Thu 22 Oct 2009 10:00:00 PM UTC
Category:  Project Approval Priority:  * 5 - Normal
Status:  Done Privacy:  Public
Assigned to:  None Open/Closed:  Closed
* Mandatory Fields

Add a New Comment Rich Markup
   

Wed 14 Oct 2009 04:41:30 PM UTC, comment #3: 

I've approved your project--welcome on board! :-)

You'll receive a mail notification with further instructions shortly.

--
Happy hacking!

Sebastian Gerhardt <sgerhardt>
Wed 14 Oct 2009 10:19:25 AM UTC, comment #2: 

Hi,

The qt4*.mkdoclib files were generated from html Qt doc using the src/extra/qt_extract.pl script as Qt use a proprietary documentation tool. The gnu_libstdc++_4.3.mkdoclib file has been generated by the main MkDoc script from the doxygen tag file.

Alexandre Becoulet <diaxen>
Wed 14 Oct 2009 08:50:22 AM UTC, comment #1: 

Hi,

can you please explain how the .mcdoclib files in the extra directory were made. Are they generated by some script?

Sebastian Gerhardt <sgerhardt>
Tue 13 Oct 2009 02:43:38 PM UTC, original submission:  

A new project has been registered at Savannah
This project account will remain inactive until a site admin approves or discards the registration.


Registration Administration


While this item will be useful to track the registration process, approving or discarding the registration must be done using the specific Group Administration page, accessible only to site administrators, effectively logged as site administrators (superuser):



Registration Details


  • Name: MkDoc C/C++ documentation tool
  • System Name:  mkdoc
  • Type: non-GNU software & documentation
  • License: GNU General Public License v2 or later





Description:

MkDoc is a code project documentation tool. It is inspired from the kdoc project by Sirtaj Singh Kang with almost complete rewrite.
MkDoc has been designed to parse C and complex C++ code while still producing clear documentation for the end user. I wrote this project because I was not satisfied with other documentation tools C++ parser abilities and couldn't find one that generate clean texinfo output.
Unlike most code generation tools Mkdoc does not directly write generated code documentation with piece of user text inside. Instead it handles plain documentation files with sections and other constructs (like texinfo or latex) and insert piece of generated code documentation on request. This way it does not enforce the way you structure your document. A template documentation source file is still provided when starting a new project to have MkDoc generating automatic code documentation in usual way. You can have a look to the html QtLua project manual and home page , both generated using MkDoc.



Other Software Required:

perl interpreter


Tarball URL:

http://savannah.gnu.org/submissions_uploads/mkdoc.tar.g


Alexandre Becoulet <diaxen>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by diaxen (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only logged-in users can vote.

     

    Follow 2 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2009-10-14 sgerhardt StatusNone Done
        Open/ClosedOpen Closed

    Back to the top

    Powered by Savane 3.13-caa5.
    Corresponding source code