libavformat I/O and muxing/demuxing library.libavfilter graph-based frame editing library.

By clicking, you can find a lot of useful information about the classes and methods present in the package calice_userlib.This document describes the usage of the different libraries provided by FFmpeg. For example, open: file:///group/hcal/calice_soft/pro_test/source/calice_userlib/doc/html/index.html in your internet browser (on a FLC machine). You can view it in your favourite browser. There, the file you are interested in is index.html. In the directory you ran doxygen, you will get a directory called html. Suppose you decided yourself for an HTML documentation. This takes a bit, probably you will see some warnings about undocumented methods, etc, which you can ignore in the first stage (you still get the documentation you added). Have fun with it and feel free to modify it according to your needs. Here you can find an example of a Doxyfile with which the above example was generated. Tells what the extension of the html files should be (.htm or. If HTML chosen, the following tells doxygen where to put the html documentation relative to OUTPUT_DIRECTORY: the type of documentation you want to generate (HTML, LaTeX and/or something else):.OUTPUT_DIRECTORY = 'your output directory' The directory where to put the documentation (if you leave it empty, then the documentation will be created in the directory where you run doxygen): The input files (relative to the directory where you run doxygen): Some of the important things you need to pay attention to are: Then you can edit the default configuration file to serve your needs. The distance is calculated with the x - x coordinate of the y - y coordinate of the z - z coordinate of the distance to pointįloat getDistance(float x, float y, float z)

**Print out the private members of the class Doing something with it.ĭetailed description follows X. ** Dummy class used for illustration purposes.

if you use special algorithms or if your class is based on certain assumptions, document them.

what are the methods of the class good for? (Even if it seems trivial for you, don't be lazy, and tell it also other people).

how it can be used (and/or possible caveats).

who is the author of the class (Marlin processor, etc) and the last modification date.

Note that the actual documentation consists in comments you write in the header file This makes your life easier not only for potential users of your code, but also for you, if you are going to reuse your code after a long period of time. It is highly recommended that you document your code.

Ffmpeg documentation doxygen