Just a little hack to make the Vorbis classes appear in the Ogg namespace

in the API docs and a tyepdef to make this work (since this is how things
will be in the next BIC version).


git-svn-id: svn://anonsvn.kde.org/home/kde/trunk/kdesupport/taglib@309150 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
This commit is contained in:
Scott Wheeler 2004-05-06 16:59:13 +00:00
parent 6a2cdbcc45
commit f9ca8cd69b
3 changed files with 49 additions and 0 deletions

View File

@ -46,5 +46,6 @@ apidox:
echo "HTML_STYLESHEET = doc/common/doxygen.css" >> taglib.doxyfile ; \
echo "FILE_PATTERNS = *.h" >> taglib.doxyfile ; \
echo "PREDEFINED = DO_NOT_DOCUMENT" >> taglib.doxyfile ; \
echo "PREDEFINED = DOXYGEN" >> taglib.doxyfile ; \
echo "EXTRACT_ALL = YES" >> taglib.doxyfile ; \
doxygen taglib.doxyfile

View File

@ -29,6 +29,17 @@
namespace TagLib {
/*
* This is just to make this appear to be in the Ogg namespace in the
* documentation. The typedef below will make this work with the current code.
* In the next BIC version of TagLib this will be really moved into the Ogg
* namespace.
*/
#ifdef DOXYGEN
namespace Ogg {
#endif
//! A namespace containing classes for Vorbis metadata
namespace Vorbis {
@ -84,6 +95,19 @@ namespace TagLib {
FilePrivate *d;
};
}
/*
* To keep compatibility with the current version put Vorbis in the Ogg namespace
* only in the docs and provide a typedef to make it work. In the next BIC
* version this will be removed and it will only exist in the Ogg namespace.
*/
#ifdef DOXYGEN
}
#else
namespace Ogg { namespace Vorbis { typedef TagLib::Vorbis::File File; } }
#endif
}
#endif

View File

@ -26,6 +26,17 @@
namespace TagLib {
/*
* This is just to make this appear to be in the Ogg namespace in the
* documentation. The typedef below will make this work with the current code.
* In the next BIC version of TagLib this will be really moved into the Ogg
* namespace.
*/
#ifdef DOXYGEN
namespace Ogg {
#endif
namespace Vorbis {
class File;
@ -91,6 +102,19 @@ namespace TagLib {
PropertiesPrivate *d;
};
}
/*
* To keep compatibility with the current version put Vorbis in the Ogg namespace
* only in the docs and provide a typedef to make it work. In the next BIC
* version this will be removed and it will only exist in the Ogg namespace.
*/
#ifdef DOXYGEN
}
#else
namespace Ogg { namespace Vorbis { typedef TagLib::AudioProperties AudioProperties; } }
#endif
}
#endif