A doxygen filter to use with Prolog
C Lex Prolog Makefile
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
tests
.gitignore
LICENSE
README.md
dox4pl
dox4pl.l
lex.yy.c
makefile
tags

README.md

DoxygenProlog: dox4pl

A doxygen filter to use with Prolog

Summary

A filter done in LEX (.l) to convert PROLOG programs into simple tokens of C/C++ that can be used to generate documentation of Prolog programs with Doxygen.

Description

You need to install this filter into your machine's PATH, and tells doxygen to use it by associating the file extension *.pl with doxygenprolog

How To?

To setup doxygen, you need:

OPTIMIZE_OUTPUT_FOR_C = NO

INPUT = README.md groups.dox yourprologsource.pl

EXTRACT_ALL = YES

EXTRACT_STATIC = YES

FILE_PATTERNS = *.pl *.prolog *.swipl

FILTER_PATTERNS = *.pl="dox4pl"

What is it like?

Take a look at the wiki site here in github, and follow to the example link.

Dox4Pl Wiki

This is still a starting prototype, but it is working very well.

Enjoy!

Dr Beco


Change Log

Build 20150703.015148
  • Added [-f filename]

You can call it by using:

dox4pl -f filename

or

dox4pl filename

If both used

dox4pl filename2 -f filename1

It will try to open both, always the one from -f first. Both failing, it will read from stdin.

Build 20150628.131912
  • Corrected the name to dox4pl (means doxygen for prolog)

After realizing dox2pl was inverted, and trying to change to pl2dox, I observed that github repository is named DoxygenProlog. Renaming the repository was not an option, since it would break all links kind people over the world added into some sites

(speciall thanks to Dimitri Doxygen Official and Jam SWI-Prolog Official).

So, changing to dox4pl solves all the problems. And as a 2 plus, its 4, not 2! ;)

Build 20150628.125352
  • Corrected the name to pl2dox (means prolog converted to doxygen)
Version 20150627.125100
  • Read from file
  • Optarg keys: hVvq and [filename]
  • makefile without -Wno-unused-function
  • IFDEBUG defined
  • License and copyright information available in source (opensource complying)
  • Doxygen comments
  • Better format of output
Version 20150626
  • First release
  • Read only from stdin (redirect < operator needed)

Program details

  • Version 20150627.125100
  • Date 2015-06-27
  • Author Ruben Carlo Benante <rcb@beco.cc> (beco)
  • Webpage <www.beco.cc>

Copyright, License and Warranty

copyright (c) 2015 GNU GPL v3

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 version 3 of the License. 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, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA. 02111-1307, USA. Or read it online at <http://www.gnu.org/licenses/>.


Template by Dr. Beco < rcb at beco dot cc > Version 20150619.231433