diff options
author | Wolf Bergenheim <ext-wolf.2.bergenheim@nokia.com> | 2010-09-16 15:22:53 +0300 |
---|---|---|
committer | Wolf Bergenheim <ext-wolf.2.bergenheim@nokia.com> | 2010-09-16 15:22:53 +0300 |
commit | c73a1276632331efff4074931e6e9dcb61f85e92 (patch) | |
tree | f79dd079af9557b5c063cc7dba50558a41c4541a /libresourceqt | |
parent | 5f82fc3a95dd342ad2ae16007dcf36bae632568a (diff) |
Updated documentation
Diffstat (limited to 'libresourceqt')
-rw-r--r-- | libresourceqt/Doxyfile | 74 | ||||
-rw-r--r-- | libresourceqt/include/qt4/policy/audio-resource.h | 25 | ||||
-rw-r--r-- | libresourceqt/include/qt4/policy/resource-set.h | 7 | ||||
-rw-r--r-- | libresourceqt/libresourceqt1.pc | 2 |
4 files changed, 50 insertions, 58 deletions
diff --git a/libresourceqt/Doxyfile b/libresourceqt/Doxyfile index f2c2e14..3918664 100644 --- a/libresourceqt/Doxyfile +++ b/libresourceqt/Doxyfile @@ -31,7 +31,7 @@ PROJECT_NAME = ResourcePolicy # This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = 1.1 +PROJECT_NUMBER = 1.17 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. @@ -115,7 +115,7 @@ INLINE_INHERITED_MEMB = NO # path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. -FULL_PATH_NAMES = YES +FULL_PATH_NAMES = NO # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag # can be used to strip a user-defined part of the path. Stripping is @@ -124,7 +124,7 @@ FULL_PATH_NAMES = YES # If left blank the directory from which doxygen is run is used as the # path to strip. -STRIP_FROM_PATH = +STRIP_FROM_PATH = include # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of # the path mentioned in the documentation of a class, which tells @@ -280,7 +280,7 @@ SUBGROUPING = YES # be useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. -TYPEDEF_HIDES_STRUCT = NO +TYPEDEF_HIDES_STRUCT = yes # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to # determine which symbols to keep in memory and which to flush to disk. @@ -307,7 +307,7 @@ SYMBOL_CACHE_SIZE = 0 # Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES -EXTRACT_ALL = YES +EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. @@ -346,14 +346,14 @@ EXTRACT_ANON_NSPACES = NO # various overviews, but no documentation section is generated. # This option has no effect if EXTRACT_ALL is enabled. -HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_MEMBERS = YES # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. # If set to NO (the default) these classes will be included in the various # overviews. This option has no effect if EXTRACT_ALL is enabled. -HIDE_UNDOC_CLASSES = NO +HIDE_UNDOC_CLASSES = YES # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all # friend (class|struct|union) declarations. @@ -406,7 +406,7 @@ INLINE_INFO = YES # alphabetically by member name. If set to NO the members will appear in # declaration order. -SORT_MEMBER_DOCS = YES +SORT_MEMBER_DOCS = NO # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the # brief documentation of file, namespace and class members alphabetically @@ -435,7 +435,7 @@ SORT_BY_SCOPE_NAME = NO # disable (NO) the todo list. This list is created by putting \todo # commands in the documentation. -GENERATE_TODOLIST = YES +GENERATE_TODOLIST = NO # The GENERATE_TESTLIST tag can be used to enable (YES) or # disable (NO) the test list. This list is created by putting \test @@ -447,7 +447,7 @@ GENERATE_TESTLIST = YES # disable (NO) the bug list. This list is created by putting \bug # commands in the documentation. -GENERATE_BUGLIST = YES +GENERATE_BUGLIST = NO # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or # disable (NO) the deprecated list. This list is created by putting @@ -486,7 +486,7 @@ SHOW_DIRECTORIES = NO # This will remove the Files entry from the Quick Index and from the # Folder Tree View (if specified). The default is YES. -SHOW_FILES = YES +SHOW_FILES = NO # Set the SHOW_NAMESPACES tag to NO to disable the generation of the # Namespaces page. This will remove the Namespaces entry from the Quick Index @@ -547,7 +547,7 @@ WARN_IF_DOC_ERROR = YES # wrong or incomplete parameter documentation, but not about the absence of # documentation. -WARN_NO_PARAMDOC = NO +WARN_NO_PARAMDOC = YES # The WARN_FORMAT tag determines the format of the warning messages that # doxygen can produce. The string should contain the $file, $line, and $text @@ -573,7 +573,7 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = include/qt4 +INPUT = ./include/qt4 # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is @@ -590,37 +590,7 @@ INPUT_ENCODING = UTF-8 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 -FILE_PATTERNS = *.c \ - *.cc \ - *.cxx \ - *.cpp \ - *.c++ \ - *.d \ - *.java \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ - *.h \ - *.hh \ - *.hxx \ - *.hpp \ - *.h++ \ - *.idl \ - *.odl \ - *.cs \ - *.php \ - *.php3 \ - *.inc \ - *.m \ - *.mm \ - *.dox \ - *.py \ - *.f90 \ - *.f \ - *.vhd \ - *.vhdl +FILE_PATTERNS = *.h # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. @@ -746,7 +716,7 @@ REFERENCES_RELATION = NO # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will # link to the source code. Otherwise they will link to the documentation. -REFERENCES_LINK_SOURCE = YES +REFERENCES_LINK_SOURCE = NO # If the USE_HTAGS tag is set to YES then the references to source code # will point to the HTML generated by the htags(1) tool instead of doxygen @@ -760,7 +730,7 @@ USE_HTAGS = NO # will generate a verbatim copy of the header file for each class for # which an include is specified. Set to NO to disable this. -VERBATIM_HEADERS = YES +VERBATIM_HEADERS = NO #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index @@ -770,7 +740,7 @@ VERBATIM_HEADERS = YES # of all compounds will be generated. Enable this if the project # contains a lot of classes, structs, unions or interfaces. -ALPHABETICAL_INDEX = NO +ALPHABETICAL_INDEX = YES # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns @@ -916,13 +886,13 @@ TOC_EXPAND = NO # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated # HTML documentation. -GENERATE_QHP = YES +GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can # be used to specify the file name of the resulting .qch file. # The path specified is relative to the HTML output folder. -QCH_FILE = ../com.nokia.policy.libresourceqt.qch +QCH_FILE = ../libresourceqt.qch # The QHP_NAMESPACE tag specifies the namespace to use when generating # Qt Help Project output. For more information please see @@ -934,7 +904,7 @@ QHP_NAMESPACE = ResourcePolicy # Qt Help Project output. For more information please see # http://doc.trolltech.com/qthelpproject.html#virtual-folders -QHP_VIRTUAL_FOLDER = doc +QHP_VIRTUAL_FOLDER = libresourceqt # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. # For more information please see @@ -992,7 +962,7 @@ GENERATE_TREEVIEW = HIERARCHIES # used to set the initial width (in pixels) of the frame in which the tree # is shown. -TREEVIEW_WIDTH = 250 +TREEVIEW_WIDTH = 350 # Use this tag to change the font size of Latex formulas included # as images in the HTML documentation. The default is 10. Note that @@ -1146,7 +1116,7 @@ MAN_EXTENSION = .3 # only source the real man page, but without them the man command # would be unable to find the correct page. The default is NO. -MAN_LINKS = NO +MAN_LINKS = YES #--------------------------------------------------------------------------- # configuration options related to the XML output diff --git a/libresourceqt/include/qt4/policy/audio-resource.h b/libresourceqt/include/qt4/policy/audio-resource.h index bb0783f..4da4b30 100644 --- a/libresourceqt/include/qt4/policy/audio-resource.h +++ b/libresourceqt/include/qt4/policy/audio-resource.h @@ -8,15 +8,27 @@ namespace ResourcePolicy { +/** + * The AudioResource class represents the audio device. It is a bit + * different from other resource types in that in takes more parameters to + * allow the programmer to classify the audio stream used by the application. + */ class AudioResource: public QObject, public Resource { Q_OBJECT public: + /** + * The constructor. + * \param audioGroup The audio group which this application belongs to. + * This is an optional parameter. + */ AudioResource(const QString &audioGroup = QString()); AudioResource(const AudioResource &other); virtual ~AudioResource(); + //! Accessor for the audioGroup. QString audioGroup() const; + //! A test to check whether the audio group is set or not. bool audioGroupIsSet() const; /** * Set the audio group (classification) @@ -24,19 +36,26 @@ public: */ void setAudioGroup(const QString & newGroup); + //! \return The PID of the process which is responsible for rendering the audio stream. quint32 processID() const; /** - * Set the PID of the process which will render the audio. Use this if the - * audio renderer is in a separate process. + * Use this to indicate to the Resource Manager the PID of the audio + * stream renderer. + * \param newPID Set this to the PID of the process which will render the audio. */ void setProcessID(quint32 newPID); + //! \return the name of the stream tag. QString streamTagName() const; + //! \return the value of the stream tag. QString streamTagValue() const; + //! A test to check whether the stream tag has been set or not. bool streamTagIsSet() const; /** * Set the tream tag to help policy to correctly identify the audio stream - * beloning to you + * beloning to you. + * \param name The name of the tag. For example "media.name" + * \param value The value of the stream tag. */ void setStreamTag(const QString &name, const QString &value); diff --git a/libresourceqt/include/qt4/policy/resource-set.h b/libresourceqt/include/qt4/policy/resource-set.h index 710dc7d..2ce18c4 100644 --- a/libresourceqt/include/qt4/policy/resource-set.h +++ b/libresourceqt/include/qt4/policy/resource-set.h @@ -31,7 +31,7 @@ * resources->addResource(VideoPlaybackType); * \endcode * If you want to pre-populate the AudioResource with the audio group (it is a good idea) - * and other oudio parameters you can create an audio object yourself and then + * and other audio parameters you can create an audio object yourself and then * give that to the ResourcePolicy::ResourceSet. Note that you should NOT free this object. * The ResourcePolicy::ResourceSet takes ownership of this pointer. * \code @@ -59,7 +59,8 @@ */ /** - * The Namespace for Resource Policy. + * \brief The Namespace for Resource Policy. + * All Resource Policy Qt APIs reside under the ResourcePolicy namespace. */ namespace ResourcePolicy { @@ -81,6 +82,8 @@ public: * The application class is used to determine the priority order of the * application. * \param parent The optional parent of of this class. + * \param alwaysReply Set this to true to always get a reply from the + * Resource Manager. This optional parameter defaults to false. */ ResourceSet(const QString &applicationClass, QObject *parent = NULL, bool alwaysReply = false, bool autoRelease = false); diff --git a/libresourceqt/libresourceqt1.pc b/libresourceqt/libresourceqt1.pc index 80e4b07..7e99227 100644 --- a/libresourceqt/libresourceqt1.pc +++ b/libresourceqt/libresourceqt1.pc @@ -5,7 +5,7 @@ includedir=${prefix}/include/resource/qt4 Name: libresourceqt1 Description: Maemo resource management Qt API -Version: 1.10 +Version: 1.17 Libs: -L${libdir} -lresourceqt Cflags: -I${includedir} Requires: dbus-1 libdbus-qeventloop1 libresource0 |