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

[mlt] / src / framework / mlt_profile.h

diff --git a/src/framework/mlt_profile.h b/src/framework/mlt_profile.h
index 6b0c42d9f328d82b31f9fe6e55eefd21a96cd7d6..18144931774237ed87af78a3cded5f2530e79a35 100644 (file)
--- a/src/framework/mlt_profile.h
+++ b/src/framework/mlt_profile.h
@@ -1,7 +1,9 @@
-/*
- * mlt_profile.h -- video output definition
- * Copyright (C) 2007 Ushodaya Enterprises Limited
- * Author: Dan Dennedy <dan@dennedy.org>
+/**
+ * \file mlt_profile.h
+ * \brief video output definition
+ *
+ * Copyright (C) 2007-2008 Ushodaya Enterprises Limited
+ * \author Dan Dennedy <dan@dennedy.org>
  *
  * 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,10 @@
 
 #include "mlt_types.h"
 
+/** \brief Profile class
+ *
+ */
+
 struct mlt_profile_s
 {
        char* description;