Commit graph

35 commits

Author SHA1 Message Date
Alexandre Duret-Lutz
df326e032b use a bibtex file to collect all references in Doxygen
* doc/tl/tl.bib: Move ...
* doc/spot.bib: ... here, and augment it with all references that
appeared verbatim in Doxygen comments.
* doc/Makefile.am, doc/tl/Makefile.am
doc/tl/tl.tex: Adjust for the move.
* doc/Doxyfile.in: Point to spot.bib.
* spot/gen/automata.hh, spot/gen/formulas.hh, spot/misc/game.hh,
spot/misc/minato.hh spot/taalgos/emptinessta.hh,
spot/taalgos/minimize.hh, spot/taalgos/tgba2ta.hh, spot/tl/formula.hh,
spot/tl/remove_x.hh, spot/tl/simplify.hh, spot/tl/snf.hh,
spot/twaalgos/cobuchi.hh, spot/twaalgos/cycles.hh,
spot/twaalgos/dualize.hh, spot/twaalgos/gtec/gtec.hh,
spot/twaalgos/gv04.hh, spot/twaalgos/ltl2taa.hh,
spot/twaalgos/ltl2tgba_fm.hh, spot/twaalgos/magic.hh,
spot/twaalgos/minimize.hh, spot/twaalgos/parity.hh,
spot/twaalgos/powerset.hh, spot/twaalgos/randomgraph.hh,
spot/twaalgos/se05.hh, spot/twaalgos/simulation.hh,
spot/twaalgos/strength.hh, spot/twaalgos/stutter.hh,
spot/twaalgos/tau03.hh, spot/twaalgos/totgba.hh,
spot/twaalgos/toweak.hh: Use \cite instead of a verbatim bibtex entry.
2019-06-14 21:02:27 +02:00
Alexandre Duret-Lutz
246b5d8fed doc: implement --enable-doxygen and do not distribute the doc
Fixes #299.

* configure.ac, doc/Makefile.am: Adjust.
* NEWS, HACKING, README: Document the change.
* doc/dot.in: Delete, not used anymore.
* doc/Doxyfile.in: Adjust to not look for dot.
* debian/rules: Use --enable-doxygen.
2017-11-22 16:06:04 +01:00
Alexandre Duret-Lutz
454cc73670 doc: use SVG in the doxygen manual
Suggested in #299.

* doc/Doxyfile.in: Here.
2017-11-22 12:03:52 +01:00
Alexandre Duret-Lutz
e1f5eb1fd6 doc: improve the twa class documentation
* spot/twa/twa.hh: More documentation.
* doc/Doxyfile.in: Allow same doc for groups of methods.
2016-02-15 11:04:48 +01:00
Alexandre Duret-Lutz
681bb82b8e * doc/Doxyfile.in: Tweak two options. 2016-02-02 17:08:11 +01:00
Alexandre Duret-Lutz
6fb4df4359 Move spot-if/ltsmin/ to spot/ltsmin/
* spot-if/ltsmin/: Rename as...
* spot/ltsmin/: ... this.
* spot-if/: Delete.
* Makefile.am, NEWS, README, configure.ac, debian/libspot-dev.install,
doc/Doxyfile.in, spot/Makefile.am, spot/sanity/80columns.test,
spot/sanity/style.test: Adjust.
2015-12-25 13:45:42 +01:00
Alexandre Duret-Lutz
b519c7d3dc rename iface/ as spot-if/
So that instead of having to do
  #incluce <spot/iface/ltsmin/ltsmin.hh>
for using installed the installed header, and
  #incluce <iface/ltsmin/ltsmin.hh>
for using the non-installed version, we now do
  #incluce <spot-if/ltsmin/ltsmin.hh>
in both cases.

* iface/: Rename as...
* spot-if/: ... this.
* doc/Doxyfile.in, README, configure.ac, Makefile.am,
spot/sanity/80columns.test, spot/sanity/style.test: Adjust.
* NEWS: Mention the change.
* spot-if/ltsmin/Makefile.am: Install headers in $includedir/spot-if.
* debian/libspot-dev.install: Distribute that directory as well.
2015-12-07 22:29:18 +01:00
Alexandre Duret-Lutz
f120dd3206 rename src/ as spot/ and use include <spot/...>
* NEWS: Mention the change.
* src/: Rename as ...
* spot/: ... this, adjust all headers to include <spot/...> instead of
"...", and adjust all Makefile.am to search headers from the top-level
directory.
* HACKING: Add conventions about #include.
* spot/sanity/style.test: Add a few more grep to catch cases
that do not follow these conventions.
* .gitignore, Makefile.am, README, bench/stutter/Makefile.am,
bench/stutter/stutter_invariance_formulas.cc,
bench/stutter/stutter_invariance_randomgraph.cc, configure.ac,
debian/rules, doc/Doxyfile.in, doc/Makefile.am,
doc/org/.dir-locals.el.in, doc/org/g++wrap.in, doc/org/init.el.in,
doc/org/tut01.org, doc/org/tut02.org, doc/org/tut03.org,
doc/org/tut10.org, doc/org/tut20.org, doc/org/tut21.org,
doc/org/tut22.org, doc/org/tut30.org, iface/ltsmin/Makefile.am,
iface/ltsmin/kripke.test, iface/ltsmin/ltsmin.cc,
iface/ltsmin/ltsmin.hh, iface/ltsmin/modelcheck.cc,
wrap/python/Makefile.am, wrap/python/ajax/spotcgi.in,
wrap/python/spot_impl.i, wrap/python/tests/ltl2tgba.py,
wrap/python/tests/randgen.py, wrap/python/tests/run.in: Adjust.
2015-12-04 20:13:59 +01:00
Alexandre Duret-Lutz
dcb9d7e8a8 doxygen: improve formula documentation
* doc/Doxyfile.in: Adjust to hide SPOT_API.
* doc/mainpage.dox: Adjust like to parse_infix_psl().
* src/tl/formula.hh: Document most methods of formula,
and fix the definition of the comparisons operator.
* src/ltlparse/public.hh, src/tl/apcollect.hh, src/tl/declenv.hh,
src/tl/defaultenv.hh, src/tl/dot.hh, src/tl/environment.hh,
src/tl/length.hh, src/tl/mark.hh, src/tl/nenoform.hh, src/tl/print.hh,
src/tl/randomltl.hh, src/tl/relabel.hh, src/tl/simpfg.hh,
src/tl/simplify.hh, src/tl/unabbrev.hh: Adjust doxygen group.
2015-09-29 23:01:30 +02:00
Alexandre Duret-Lutz
c7e6733eb3 * doc/Doxyfile.in: Upgrade to Doxygen 1.8.9.1. 2015-06-21 13:59:26 +02:00
Alexandre Duret-Lutz
d8b3062b35 * doc/Doxyfile.in: Fix input encoding. 2015-06-17 11:38:21 +02:00
Alexandre Duret-Lutz
542050bab4 * doc/Doxyfile.in: Hide private functions and member. Enable search. 2013-07-29 01:14:37 +02:00
Alexandre Duret-Lutz
178ba87681 Improve documentation here and there.
* doc/Doxyfile.in: Update to Doxygen 1.8.4
* doc/footer.html: Point to the mailing list.
* doc/mainpage.dox: Point to spot::translator,
and spot::kripke.
* src/ta/tgta.hh: Do not use \emph.
* src/tgba/succiter.hh: Fix rendering of example.
* src/tgba/tgba.hh: Correct documentation.
* src/tgbaalgos/cycles.hh: Improve rendering of
documentation.
* src/tgbaalgos/lbtt.hh, src/tgbaalgos/minimize.hh:
Document missing arguments.
2013-06-09 15:55:57 +02:00
Alexandre Duret-Lutz
6b503d43a9 Remove spotref.pdf.
* doc/Doxyfile.in: Do not generate LaTeX output.
* doc/Makefile.am: Do not build spotref.pdf.
* NEWS, README: Adjust.
2011-11-28 15:22:48 +01:00
Alexandre Duret-Lutz
5b87fa628d Build doxygen pictures with libgd to reduce their size.
Doxygen only knows how to call dot with -Tpng, while using
-Tpng:gd produces pictures that are 10 times smaller.  Use a
simple wrapper around dot to simplify this.

* doc/dot.in: New file, that wrap the system's dot and replace
-Tpng by -Tpng:gd.
* doc/Makefile.am ($(srcdir)/stamp): Depend on dot.
* doc/Doxyfile.in: Update to 1.6.2.
(DOT_PATH): Set to @srcdir@ to use doc/dot instead of the
system's dot.
* configure.ac: Find the absolute path of dot, and generate
the doc/dot script.
2010-01-31 20:26:27 +01:00
Alexandre Duret-Lutz
c06c95c4f1 * doc/Doxyfile.in (LATEX_HIDE_INDICES): Do not generate indices
until Doxygen is fixed.  Doxygen 1.5.5 generate incorrect LaTeX
code.
2008-03-11 15:07:09 +01:00
Alexandre Duret-Lutz
82583754cd * NEWS, configure.in: Bump version to 0.4.
* HACKING, INSTALL, doc/Doxyfile.in, lbtt/INSTALL: Update to newer
tools.
2008-02-25 14:37:53 +01:00
Alexandre Duret-Lutz
b054139e6d * doc/Doxyfile.in (FILE_PATTERNS): Remove *.hxx.
* src/sanity/80columns.test, src/sanity/style.test: Process *.hxx files.
* src/tgbaalgos/ndfs_result.hh: Rename as ..
* src/tgbaalgos/ndfs_result.hxx: ... this, so it does not get
documented (and so Doxygen do not complain).
* src/tgbaalgos/magic.cc, src/tgbaalgos/se05.cc, src/tgbaalgos/tau03.cc,
src/tgbaalgos/tau03opt.cc: Adjust include.
* src/tgbaalgos/Makefile.am: Rename ndfs_result.hh as ndfs_result.hxx
and do not install it, this is a private header.
2005-01-03 17:39:43 +00:00
Alexandre Duret-Lutz
685c23a756 * doc/Doxyfile.in: Update for Doxygen 1.4.0, set
DOT_MULTI_TARGETS, and disable GROUP_GRAPH (it causes segfault).
* src/tgbaparse/public.hh (format_tgba_parse_errors): Complete
Doxygen comment.
2005-01-03 16:40:15 +00:00
Alexandre Duret-Lutz
988dbbd367 * doc/Doxyfile.in (EXCLUDE_SYMLINKS): Set to YES, since we have no
legitimate symlink in our source tree.  Requested by Akim Demaille.
2004-12-20 13:35:33 +00:00
Alexandre Duret-Lutz
2cd298e4b0 * src/tgba/bdddict.hh, src/tgba/state.hh, src/tgba/statebdd.hh,
src/tgba/succiter.hh, src/tgba/succiterconcrete.hh,
src/tgba/tgba.hh, src/tgba/tgbabddconcrete.hh,
src/tgba/tgbabddconcreteproduct.hh, src/tgba/tgbaexplicit.hh,
src/tgba/tgbaproduct.hh, src/tgba/tgbareduc.hh,
src/tgba/tgbatba.hh, src/tgbaalgos/emptiness.hh,
src/tgbaalgos/magic.hh, src/tgbaalgos/replayrun.hh,
src/tgbaalgos/gtec/gtec.hh, iface/gspn/ssp.hh: Introduce Doxygen
groups in the documentation.  Presently this only covers the
tgba/ directory, and the emptiness-check algorithms.
* doc/Doxyfile.in (EXCLUDE_PATTERNS): Skip Bison-generated files
in src/evtgbaparse/.
2004-11-16 23:47:50 +00:00
Alexandre Duret-Lutz
6e40095471 * doc/Doxyfile.in: Upgrade to Doxygen 1.3.9. 2004-10-08 13:57:49 +00:00
Alexandre Duret-Lutz
4531700d36 * doc/Doxyfile.in (GENERATE_TAGFILE): Build spot.tag.
* doc/Makefile.am (dist_pkgdata_DATA): Add spot.tag.
2004-08-12 16:48:08 +00:00
Alexandre Duret-Lutz
15785496d8 * doc/Doxyfile.in (STRIP_FROM_PATH): Strip @srcdir@ so its
does not appear when listing mainpage.dox.
2004-08-12 14:25:49 +00:00
Alexandre Duret-Lutz
04fc0b986f * doc/Doxyfile.in (STRIP_FROM_INC_PATH): Define, so that the
`#include' references are correct.
2004-08-09 13:40:09 +00:00
Alexandre Duret-Lutz
3d6a75ecfa * doc/Doxyfile.in: Update for Doxygen 1.3.8. 2004-07-26 12:15:49 +00:00
Alexandre Duret-Lutz
c534bac478 * doc/footer.html: New file, link to RefDocComments on the wiki.
* doc/Doxyfile.in (HTML_FOOTER): Use footer.html.
* doc/Makefile.am (EXTRA_DIST): Add footer.html.
2004-07-09 14:51:56 +00:00
Alexandre Duret-Lutz
9c0b0c53e6 * doc/Makefile.am (EXTRA_DIST, spot.html): Built the html
documentation in $(srcdir) since it is distributed.
* doc/Doxyfile.in (HTML_OUTPUT): Likewise.  Upgrade to Doxygen 1.3.7.
2004-05-18 09:21:25 +00:00
Alexandre Duret-Lutz
c2892a8275 * doc/Doxyfile.in: Upgrade to Doxygen 1.3.5. Build
documentation for iface/.
* dox/mainpage.dox: Fix reference to ltl_to_tgba.
* src/ltlenv/environment.hh: Typo.
2003-12-29 12:14:04 +00:00
Alexandre Duret-Lutz
e562620885 * doc/Doxyfile.in (HAVE_DOT): Set to YES to output
collaboration diagrams.
* doc/mainpage.dox: Typo.

* src/tgba/state.hh (state::as_bdd): Delete.
* src/tgba/tgbaproduct.hh (state_bdd_product): Inherit from state,
not state_bdd.
(state_bdd_product::state_bdd_product): Adjust.
* src/tgba/tgbaproduct.cc (state_bdd_product::state_bdd_product):
Adjust.

* src/tgba/succiter.hh (tgba_bdd_succ_iterator::done):
Mark as const.
* src/tgba/succiterconcrete.cc
(tgba_succ_iterator_concrete::done): Likewise.
* src/tgba/succiterconcrete.hh
(tgba_succ_iterator_concrete::done): Likewise.
* src/tgba/tgbaexplicit.cc
(tgba_explicit_succ_iterator::done): Likewise.
* src/tgba/tgbaexplicit.hh
(tgba_explicit_succ_iterator::done): Likewise.
* src/tgba/tgbaproduct.cc
(tgba_product_succ_iterator::done): Likewise.
* src/tgba/tgbaproduct.hh
(tgba_product_succ_iterator::done): Likewise.
* src/tgba/tgbatranslateproxy.hh
(tgba_translate_proxy_succ_iterator::done): Likewise.
* src/tgba/tgbatranslateproxy.cc
(tgba_translate_proxy_succ_iterator::done): Likewise.

* src/tgba/succiterconcrete.cc
(tgba_succ_iterator_concrete::next): Call bdd_satoneset
on data_.varandnext_set.  The previous implementation
was wrong for GFa.
* src/tgba/tgbabddcoredata.hh: Declare varandnext_set.
* src/tgba/tgbabddcoredata.cc: Handle varandnext_set.
2003-06-30 15:38:41 +00:00
Alexandre Duret-Lutz
b53d8aac71 * doc/Doxygen.in: Enable LaTeX output.
* doc/Makefile.am (spotref.pdf): New rule.
(EXTRA_DIST): Add spotref.pdf.
2003-06-30 12:07:30 +00:00
Alexandre Duret-Lutz
ecda9e2641 * doc/mainpage.dox: New file.
* doc/Makefile.am (EXTRA_DIST): Add mainpage.dox.
* doc/Doxyfile.in (INPUT): Add @srcdir@/mainpage.dox
2003-06-26 14:57:09 +00:00
Alexandre Duret-Lutz
5d26d6f01e * doc/Makefile.am: Rewrite to run Doxygen whenever Doxyfile.in
or configure.ac changes.  Distribute the html doc.
* doc/Doxyfile.in (EXCLUDE_PATTERNS): Complete with
useless Bison classes.
(FILE_PATTERNS): Remove *.cc files.
2003-06-26 12:34:08 +00:00
Alexandre Duret-Lutz
d35817ccd9 * src/ltlast/atomic_prop.hh, src/ltlast/binop.hh,
src/ltlast/constant.hh, src/ltlast/formula.hh,
src/ltlast/multop.hh, src/ltlast/unop.hh, src/ltlast/visitor.hh,
src/ltlenv/defaultenv.hh, src/ltlenv/environment.hh,
src/ltlparse/public.hh, src/ltlvisit/clone.hh,
src/ltlvisit/dotty.hh, src/ltlvisit/dump.hh,
src/ltlvisit/equals.hh, src/ltlvisit/lunabbrev.hh,
src/ltlvisit/nenoform.hh, src/ltlvisit/tunabbrev.hh: Add
Doxygen comments.
* src/visitor.hh: Do not use const_sel.  This clarify
the code and helps Doxygen.
2003-04-18 15:02:55 +00:00
Alexandre Duret-Lutz
4cf59e76b8 * configure.ac: Output doc/Doxyfile and doc/Makefile.
* doc/Makefile.am, doc/Doxyfile.in: New files.
* Makefile.am (SUBDIRS): Add doc.
2003-04-18 10:29:18 +00:00