doc: add examples to the Doxygen documentation

[libam7xxx.git] / examples / am7xxx-play.c

diff --git a/examples/am7xxx-play.c b/examples/am7xxx-play.c
index b28ecec..54f92e9 100644 (file)
--- a/examples/am7xxx-play.c
+++ b/examples/am7xxx-play.c
@@ -17,6 +17,12 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @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 <stdio.h>
 #include <stdint.h>
 #include <string.h>