src/framework/*: improve the doxygen documentation (work in progress). This also...

[mlt] / src / framework / mlt_parser.h

diff --git a/src/framework/mlt_parser.h b/src/framework/mlt_parser.h
index 48df1b8fcf36af8c722c53c53bcef659b4e98489..08f6ffbfdddc83aae96c8de1978eb5728fceb538 100644 (file)
--- a/src/framework/mlt_parser.h
+++ b/src/framework/mlt_parser.h
@@ -1,7 +1,9 @@
-/*
- * mlt_parser.h -- service parsing functionality
- * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
+/**
+ * \file mlt_parser.h
+ * \brief service parsing functionality
+ *
+ * Copyright (C) 2003-2008 Ushodaya Enterprises Limited
+ * \author Charles Yates <charles.yates@pandora.be>
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -23,6 +25,11 @@
 
 #include "mlt_types.h"
 
+/** \brief Parser class
+ *
+ * \extends mlt_properties_s
+ */
+
 struct mlt_parser_s
 {
        struct mlt_properties_s parent;