[Savannah-register-public] [task #9789] Submission of MkDoc C/C++ documentation tool

[Alexandre Becoulet]

URL:
  <http://savannah.gnu.org/task/?9789>

                 Summary: Submission of MkDoc C/C++ documentation tool
                 Project: Savannah Administration
            Submitted by: diaxen
            Submitted on: Tue 13 Oct 2009 04:43:38 PM CEST
         Should Start On: Tue 13 Oct 2009 12:00:00 AM CEST
   Should be Finished on: Fri 23 Oct 2009 12:00:00 AM CEST
                Category: Project Approval
                Priority: 5 - Normal
                  Status: None
                 Privacy: Public
        Percent Complete: 0%
             Assigned to: None
             Open/Closed: Open
         Discussion Lock: Any
                  Effort: 0.00

    _______________________________________________________

Details:

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
<https://savannah.gnu.org/siteadmin/groupedit.php?group_id=10367> page*,
accessible only to site administrators, effectively *logged as site
administrators* (superuser):

* Group Administration
<https://savannah.gnu.org/siteadmin/groupedit.php?group_id=10367>


= 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






    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/task/?9789>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/