Fixes the following warnings:
include/vlc_objects.h:246: warning: argument 'obj' of command @param is not found in the argument list of vlc_obj_calloc(_Generic((vlc_object_t *obj) ->obj, struct vlc_object_marker *:(vlc_object_t *obj), default:(&((vlc_object_t *obj) ->obj))), size_t nmemb, size_t size)
include/vlc_objects.h:276: warning: argument 'obj' of command @param is not found in the argument list of vlc_obj_free(_Generic((vlc_object_t *obj) ->obj, struct vlc_object_marker *:(vlc_object_t *obj), default:(&((vlc_object_t *obj) ->obj))), void *ptr)
include/vlc_objects.h:232: warning: argument 'obj' of command @param is not found in the argument list of vlc_obj_malloc(_Generic((vlc_object_t *obj) ->obj, struct vlc_object_marker *:(vlc_object_t *obj), default:(&((vlc_object_t *obj) ->obj))), size_t size)
include/vlc_objects.h:262: warning: argument 'obj' of command @param is not found in the argument list of vlc_obj_strdup(_Generic((vlc_object_t *obj) ->obj, struct vlc_object_marker *:(vlc_object_t *obj), default:(&((vlc_object_t *obj) ->obj))), const char *str)
Allow the configure script to substitute the theme used in the
documentation for Awesome doxygen css from the CI script.
The theme won't be mandatory, but we can change it and inject it for the
production documentation online.
It is not always desirable to have documentation mixed with code.
This, as an example, applies to documentation about a certain feature
spanning several headers; or example implementations to aid future
developers.
These changes creates a designated place for such documentation.
Signed-off-by: Thomas Guillem <thomas@gllm.fr>
New doxygen command \libvlc_return_bool means that wrapper generators
should translate returning int to a boolean value.
For example, this is useful for Ruby, where every number, including 0,
is considered to be true.
For normal HTML/LaTeX documentation it's invisible.
Signed-off-by: Rémi Denis-Courmont <remi@remlab.net>
* changed project name from 'vlc' to 'VLC'
* excluded src/extras from the documentation
src/misc/variables.c, include/variables.h:
* Doxygen-documented most of the vlc variables code
* Extract documentation on static functions, useful to get the static
inline functions defined in header files listed. Drawback is that private
functions in source files are also listed.
documentation does not include information on which headers each file
includes, since this information isn't correct.
Clarified and doxygenized some of the documentation on subpictures
includes in the .h files, since they are parsed out of context by
doxygen
Doxyfile: misc fixes, use ./toolbox --add-include as filter for sources.
include/vlc_common.h: doxygenized VLC_COMMON_MEMBERS
With these changes, and a slightly patched version of doxygen (which you can
get here: http://www.idi.ntnu.no/~sigmunau/doxygen-vlcpatched.tgz ) you should
be able to get some useful documentation out of the vlc sources.
Alexandre Janniaux
Rémi Denis-Courmont
Filip Roséen
Jean-Baptiste Kempf
Alexey Sokolov
Rémi Duraffort
Rémi Denis-Courmont
Antoine Cellerier
Clément Stenac
Christophe Mutricy
Sigmund Augdal Helberg
Olivier Teulière