From: Antonio Ospite Date: Fri, 23 Mar 2012 21:01:45 +0000 (+0100) Subject: doc: add examples to the Doxygen documentation X-Git-Tag: v0.1.0~1^2~5 X-Git-Url: https://git.ao2.it/libam7xxx.git/commitdiff_plain/b2281e337903266b7c276d5e1ccc0542c109fa70?ds=sidebyside;hp=--cc doc: add examples to the Doxygen documentation --- b2281e337903266b7c276d5e1ccc0542c109fa70 diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index a1554c4..4e6a877 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -96,7 +96,8 @@ WARN_LOGFILE = # configuration options related to the input files #--------------------------------------------------------------------------- INPUT = @CMAKE_CURRENT_SOURCE_DIR@/ \ - @CMAKE_SOURCE_DIR@/src/ + @CMAKE_SOURCE_DIR@/src/ \ + @CMAKE_SOURCE_DIR@/examples/ INPUT_ENCODING = UTF-8 FILE_PATTERNS = *.dox \ *.h \ @@ -106,8 +107,8 @@ EXCLUDE = EXCLUDE_SYMLINKS = NO EXCLUDE_PATTERNS = EXCLUDE_SYMBOLS = -EXAMPLE_PATH = -EXAMPLE_PATTERNS = +EXAMPLE_PATH = @CMAKE_SOURCE_DIR@/examples/ +EXAMPLE_PATTERNS = *.c EXAMPLE_RECURSIVE = NO IMAGE_PATH = INPUT_FILTER = diff --git a/examples/am7xxx-play.c b/examples/am7xxx-play.c index b28ecec..54f92e9 100644 --- a/examples/am7xxx-play.c +++ b/examples/am7xxx-play.c @@ -17,6 +17,12 @@ * along with this program. If not, see . */ +/** + * @example examples/am7xxx-play.c + * am7xxx-play uses libavdevice, libavformat, libavcodec and libswscale to + * decode the input, encode it to jpeg and display it with libam7xxx. + */ + #include #include #include diff --git a/examples/picoproj.c b/examples/picoproj.c index c3b199c..2970585 100644 --- a/examples/picoproj.c +++ b/examples/picoproj.c @@ -16,6 +16,11 @@ * along with this program. If not, see . */ +/** + * @example examples/picoproj.c + * A minimal example to show how to use libam7xxx to show a static image. + */ + #include #include #include