Txt2FPDoc
version 0.8.6a

Yann Mérignac (yann.merignac@laposte.net)
27/09/2015

License | Documentation | Changes | Downloads

Txt2FPDoc is a documentation generator for generating API documentation from Pascal source code or text files. It’s a command line utility that converts a documentation file written in human readable language to an XML file suitable for FPDoc.

Txt2FPDoc tries to make documentation easy to read (almost as readable as plain English) and easy to write (no cryptic tags, only light markups like **bold** and //italic//).

Documentation can be stored in one or more text files or directly included in source code.

Here’s a quick example of how to document a function for Txt2FPDoc :

{**
  Function: Multiply -- Multiplies two integers.

  Parameters:
    - A -- first integer
    - B -- second integer

  Result:

    The two integers multiplied together.
}
function Multiply(A, B: Integer) : Integer;

And here’s how it appears in the documentation generated by FPDoc :

License

GNU

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

Documentation

Documentation for the latest version is available in the following formats:

Changes

v0.8.6a (27/09/2015)

 - Corrected: Now slashes are properly removed from the pascal source code
   read.

v0.8.6 (27/07/2015)

 - Added: $include_numbered directive
 - Added: ouput of a statistics line
 - Improved: command line check

v0.8.4 (20/07/2015)

 - First release

Downloads