comment on

This is not really a Perl question, but the monastery is good place to ask. ;)

I'm looking for a good and simple format for documentation. Actually is for wxWindows, we are looking for a standart format for the documentation, but it need to be simple and integrated with the API.

The format need to be simple, like POD, to everyone be able to write it fast. And need to handle C/C++ codes, since this is for C++ classes.

Now the wxWindows documentation is based on Latex, that is converted to HTML (and other formats). But the Latex format isn't simple, is hard like HTML (compared to POD). The idea is to also have a format easy to extract information by other programs (or at least be able to convert it easy to a XML base).

I was thinking in POD, but there is better ways?

If I'm not wrong, Perl6 won't use POD. What format Perl6 will use?

I will be glad if some monks list the documentation formats that they know (with some explanation/examples). ;-P

Graciliano M. P.
"The creativity is the expression of the liberty".

In reply to What's the best plain Documentation format? by gmpassos

Are you posting in the right place? Check out Where do I post X? to know for sure.
Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
<code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
Want more info? How to link or How to display code and escape characters are good places to start.


P is for Practical
	PerlMonks