Commit Graph

14 Commits

Author SHA1 Message Date
Frank Dana
5e1b6fd740 Minor adjustments to Doxygen API docs (#376)
- Define `USE_IMAGEMAGICK` and `USE_BLACKMAGIC` unconditionally when
  building docs, so that the classes will be documented.
- Improve handling of `std::`-prefixed types in doxygen output.
2019-11-29 22:08:09 -05:00
FeRD (Frank Dana)
26090c2f0c Set the dot graphs to generate as interactive SVG 2019-06-13 06:57:54 -04:00
FeRD (Frank Dana)
55f26a226d Doxyfile.in: Switch on referenced-by linking 2019-06-13 00:06:01 -04:00
FeRD (Frank Dana)
7319201e37 Doygen: Include doc/*.md in docs
Also include the documentation MarkDown pages in the Doxygen docs.
These will show up as Related Pages in the interface.

* The formatting of `INSTALL-*.md` had to be changed some:
  - Doxygen doesn't support headings in bulleted lists (lines starting
    with `* ###`) -- I'm not even sure that's legal markdown. They were
    changed to just level 3 headings (lines starting with `###`).
  - ALL Windows paths in `INSTALL-WINDOWS.md` were wrapped in backticks,
    to prevent Doxygen parsing them as markup commands.
  - Level 1 headings were added to the top of the three install docs,
    giving them the title "Building libopenshot for ___(OS)___".
    Otherwise all three pages were titled "Getting Started".

* Separately, the table at the top of `HW-ACCEL.md` does not
  translate well to Doxygen. It will need further polishing. But the
  docs are all quite readable now.
2019-06-12 22:44:05 -04:00
FeRD (Frank Dana)
3ba6ba2a29 Upgrade Doyfile.in
Some arguments are obsolete with recent doxygen (and we never used
them anyway), upgraded file with `doxygen -u` to remove.
2019-06-12 21:21:58 -04:00
FeRD (Frank Dana)
df4fc4b054 Doxyfile.in: Remove doc/InstallationGuide.pdf
No longer exists.
2019-06-12 21:20:37 -04:00
Frank Dana
7d8c1da2c2 Doxyfile.in: Exclude all examples
The source has been reorganized since the doxygen configs
were last updated; there are more examples that should be
excluded, and they're all now under `src/examples/`, so exclude
the entire dir.
2019-06-12 21:16:56 -04:00
FeRD (Frank Dana)
ae96690e07 Doxyfile.in: Exclude python source 2019-06-09 08:31:40 -04:00
Jonathan Thomas
ff39fdaaf4 Updated Eclipse/Aptana project file with improved cmake build targets
Updated Doxygen definition file (for generating documention)
2015-02-04 23:53:39 -06:00
Jonathan Thomas
9801c76878 Refactored the /doc folder, added detailed illustrations to a few classes and the main page of documentation, and integrated the Official Installation Guide PDF into the documentation. 2013-09-14 22:52:29 -05:00
Jonathan Thomas
58090ef5fc Added license and copyright to all files. Improved many examples and documentation. Refactored the Coordinate() object, to move a few properties to methods. 2013-09-12 17:52:10 -05:00
Jonathan Thomas
234201743a Improved more documenation, and switched to @ syntax for doxygen. 2013-09-09 23:32:16 -05:00
Jonathan Thomas
14a61f9c5c Refactored a few methods, added new doxygen format, and improved the copyright, license, and comments & documentation for many classes and methods. 2013-09-08 23:09:54 -05:00
Jonathan Thomas
161e8923af Initial check-in of OpenShot Library 2011-10-11 08:44:27 -05:00