Commits

shuerhaaken committed 73bf0d4

fix doc creation and installation

  • Participants
  • Parent commits 9c41e59

Comments (0)

Files changed (11)

+commit 9c41e590bacb2db279b3ee4ee393f2db5b7294b6
+Author: Jörn Magens <shuerhaaken@googlemail.com>
+Date:   Wed Oct 23 16:00:12 2013 +0200
+
+    fix doc creation and installation
+
 commit 26261ac7145f75a86a2ff59bf71defd534806e06
 Author: Jörn Magens <shuerhaaken@googlemail.com>
 Date:   Wed Oct 23 13:02:30 2013 +0200

File libtaginfo/info.cc

  * This is a recommended way for accessing media tags through libtaginfo.
  * create_with_format() will return a matching Info subclass
  * \return the according Info subclass
- * \param file is the path to a media file.
+ * \param filename is the path to a media file.
  * \param format is the MediaFileType.
  */
 Info * Info::create_with_format(const String &filename, MediaFileType format) {
  * This is a recommended way for accessing media tags through libtaginfo.
  * create() will return a matching Info subclass
  * \return the according Info subclass
- * \param file is the path to a media file.
+ * \param filename is the path to a media file.
  *
  * This function will make use of the file extension to find out the media type
  */

File libtaginfo/taginfo.h

 using namespace TagLib;
 using namespace std;
 
+/** @file */
+
 /*! \mainpage TagInfo Documentation
  * 
  * <b>libtaginfo is a wrapper library for taglib</b> and alows access to media tags in an abstract way.
     //! A simple, generic interface to common audio meta data fields
     
     /*!
-    * \class Info is an attempt to abstract away the difference in the meta data formats
-    * of various audio codecs and tagging schemes.  
+    * Info is an abstract base class for media tag reading/writing  
     */
     class Info {
         protected :
             virtual String   get_lyrics(void) const;
             virtual bool     set_lyrics(const String &lyrics);
             
-            /*!
-             * Create a Info object from a media file.
-             *
-             * This is a recommended way for accessing media tags through libtaginfo.
-             * create() will return a matching Info subclass
-             * \return the according Info subclass
-             * \param file is the path to a media file.
-             *
-             * This function will make use of the file extension to find out the media type
-             */
-            static Info * create(const String &file);
-            
-            /*!
-             * Create a Info from \a file. If \a format is given, libtaginfo will try to create 
-             * an Info object for the desired \a format.
-             * This is a recommended way for accessing media tags through libtaginfo.
-             * create_with_format() will return a matching Info subclass
-             * \return the according Info subclass
-             * \param file is the path to a media file.
-             * \param format is the MediaFileType.
-             */
+            // CREATION METHODS
+            static Info * create(const String &filename);
             static Info * create_with_format(const String &file, MediaFileType format);
-            
-            /*!
-             * Create a Info from \param filename . If \param mime_type is given, libtaginfo 
-             * will try to create an Info object for the desired mime_type.
-             * This is a recommended way for accessing media tags through libtaginfo.
-             * create_from_mime() will return a matching Info subclass
-             * \return the according Info subclass
-             * \param filename is the path to a media file.
-             * \param mime_type is the mime type of the media file (e.g. "audio/x-vorbis+ogg") 
-             * as TagLib::String.
-             */
             static Info * create_from_mime(const String &filename, const String &mime_type);
     };
 }

File libtaginfo/taginfo_apetags.h

 using namespace TagLib;
 using namespace TagInfo;
 
+/** @file */
 
 
 namespace TagInfo {
     
     // GENERAL APE
     /*!
-     * \class ApeInfo A common implementation of Info for media files with ape tags.
+     * ApeTagInfo is a common implementation of Info for media files with ape tags.
     */        
     class ApeTagInfo : public Info {
         protected:
     // FILE TYPES
     
     /*!
-     * \class ApeInfo An implementation of Info for ape files.
+     * ApeInfo Implementation of Info for ape files.
     */        
     class ApeInfo : public ApeTagInfo {
         protected:
     
     
     /*!
-     * \class MpcInfo An implementation of Info for mpc files.
+     * MpcInfo is an implementation of Info for mpc files.
     */        
     class MpcInfo : public ApeTagInfo {
         protected :
     
     
     /*!
-     * \class WavPackInfo An implementation of Info for wv files.
+     * WavPackInfo is an implementation of Info for wv files.
     */        
     class WavPackInfo : public ApeTagInfo {
         protected :

File libtaginfo/taginfo_asftags.h

 using namespace TagLib;
 using namespace TagInfo;
 
+/** @file */
 
 
 namespace TagInfo {

File libtaginfo/taginfo_id3tags.h

 using namespace TagLib;
 using namespace TagInfo;
 
-
-
+/** @file */
 
 
 namespace TagInfo {

File libtaginfo/taginfo_image.h

 #include "taginfo.h"
 
 
+/** @file */
+
 
 namespace TagInfo {
     

File libtaginfo/taginfo_internal.h

 
 using namespace TagLib;
 
+/** @file */
+
+
 namespace TagInfo {
     
     //! \enum ChangedData Internal change flags for implementations

File libtaginfo/taginfo_modtags.h

 using namespace TagLib;
 using namespace TagInfo;
 
+/** @file */
 
 
 

File libtaginfo/taginfo_mp4tags.h

 using namespace TagLib;
 using namespace TagInfo;
 
+/** @file */
 
 
 namespace TagInfo {

File libtaginfo/taginfo_xiphtags.h

 using namespace TagInfo;
 
 
+/** @file */
+
 
 namespace TagInfo {