ardour/livetrax
13
0
Fork 0
Code

Assorted doxygen fixes; no functional changes.

Browse Source 
git-svn-id: svn://localhost/ardour2/branches/3.0@9575 d708f5d6-7413-0410-9779-e7cbd77b26cf
This commit is contained in:
Carl Hetherington 2011-05-23 22:12:45 +00:00
parent f7dae62903
commit b6587ad160
12 changed files with 35 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/Doxyfile
View File

@ -523,7 +523,7 @@ WARNINGS = YES
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
# automatically be disabled. # automatically be disabled.
WARN_IF_UNDOCUMENTED = YES WARN_IF_UNDOCUMENTED = NO
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some # potential errors in the documentation, such as not documenting some
@ -564,7 +564,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories # directories like "/usr/src/myproject". Separate the files or directories
# with spaces. # with spaces.
INPUT = ../libs/ardour ../gtk2_ardour ../libs/pbd ../libs/gtkmm2ext mainpage.txt INPUT = ../libs/ardour ../gtk2_ardour ../libs/pbd ../libs/gtkmm2ext ../libs/evoral mainpage.txt
# This tag can be used to specify the character encoding of the source files # 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 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is

2
gtk2_ardour/editor_snapshots.cc
View File

@ -108,7 +108,7 @@ EditorSnapshots::button_press (GdkEventButton* ev)
/** Pop up the snapshot display context menu. /** Pop up the snapshot display context menu.
* @param button Button used to open the menu. * @param button Button used to open the menu.
* @param time Menu open time. * @param time Menu open time.
* @snapshot_name Name of the snapshot that the menu click was over. * @param snapshot_name Name of the snapshot that the menu click was over.
*/ */
void void
EditorSnapshots::popup_context_menu (int button, int32_t time, std::string snapshot_name) EditorSnapshots::popup_context_menu (int button, int32_t time, std::string snapshot_name)

5
libs/ardour/session_state.cc
View File

@ -648,7 +648,8 @@ Session::remove_pending_capture_state ()
} }
/** Rename a state file. /** Rename a state file.
* @param snapshot_name Snapshot name. * @param old_name Old snapshot name.
* @param new_name New snapshot name.
*/ */
void void
Session::rename_state (string old_name, string new_name) Session::rename_state (string old_name, string new_name)
@ -676,7 +677,7 @@ Session::rename_state (string old_name, string new_name)
} }
/** Remove a state file. /** Remove a state file.
* @param snapshot_name Snapshot name. * @param snapshot_name Snapshot name.
*/ */
void void
Session::remove_state (string snapshot_name) Session::remove_state (string snapshot_name)

2
libs/ardour/tempo.cc
View File

@ -2104,7 +2104,7 @@ TempoMap::framewalk_to_beats (framepos_t pos, framecnt_t distance) const
/** Compare the time of this with that of another MetricSection. /** Compare the time of this with that of another MetricSection.
* @param with_bbt True to compare using ::start(), false to use ::frame(). * @param with_bbt True to compare using start(), false to use frame().
* @return -1 for less than, 0 for equal, 1 for greater than. * @return -1 for less than, 0 for equal, 1 for greater than.
*/ */

2
libs/gtkmm2ext/gtkmm2ext/dndvbox.h
View File

@ -127,7 +127,7 @@ public:
} }
} }
/** @param Child /** @param child Child
* @return true if the child is selected, otherwise false. * @return true if the child is selected, otherwise false.
*/ */
bool selected (T* child) const { bool selected (T* child) const {

20
libs/pbd/file_manager.cc
View File

@ -193,13 +193,13 @@ FileDescriptor::release ()
/** @param n Filename. /** @param file_name Filename.
* @param w true to open writeable, otherwise false. * @param writeable true to open writeable, otherwise false.
* @param m Open mode for the file. * @param mode Open mode for the file.
*/ */
FdFileDescriptor::FdFileDescriptor (string const & n, bool w, mode_t m) FdFileDescriptor::FdFileDescriptor (string const & file_name, bool writeable, mode_t mode)
: FileDescriptor (n, w) : FileDescriptor (file_name, writeable)
, _fd (-1) , _fd (-1)
, _mode (m) , _mode (m)
{ {
@ -259,14 +259,14 @@ FileDescriptor::set_path (const string& p)
_path = p; _path = p;
} }
/** @param n Filename. /** @param file_name Filename.
* @param w true to open writeable, otherwise false. * @param mode Mode to pass to fopen.
*/ */
StdioFileDescriptor::StdioFileDescriptor (string const & n, std::string const & m) StdioFileDescriptor::StdioFileDescriptor (string const & file_name, std::string const & mode)
: FileDescriptor (n, false) : FileDescriptor (file_name, false)
, _file (0) , _file (0)
, _mode (m) , _mode (mode)
{ {
manager()->add (this); manager()->add (this);
} }

4
libs/pbd/pbd/file_manager.h
View File

@ -89,7 +89,7 @@ private:
class FdFileDescriptor : public FileDescriptor class FdFileDescriptor : public FileDescriptor
{ {
public: public:
FdFileDescriptor (std::string const &, bool, mode_t); FdFileDescriptor (std::string const & file_name, bool writeable, mode_t mode);
~FdFileDescriptor (); ~FdFileDescriptor ();
int allocate (); int allocate ();
@ -110,7 +110,7 @@ private:
class StdioFileDescriptor : public FileDescriptor class StdioFileDescriptor : public FileDescriptor
{ {
public: public:
StdioFileDescriptor (std::string const &, std::string const &); StdioFileDescriptor (std::string const & file_name, std::string const & mode);
~StdioFileDescriptor (); ~StdioFileDescriptor ();
FILE* allocate (); FILE* allocate ();

2
libs/pbd/pbd/search_path.h
View File

@ -68,7 +68,7 @@ public:
* Initialize SearchPath from a vector of paths that may or may * Initialize SearchPath from a vector of paths that may or may
* not exist. * not exist.
* *
* @param path A path. * @param paths A vector of paths.
*/ */
SearchPath (const std::vector<PBD::sys::path>& paths); SearchPath (const std::vector<PBD::sys::path>& paths);

4
libs/pbd/pbd/sequence_property.h
View File

@ -110,7 +110,7 @@ class SequenceProperty : public PropertyBase
/** Get a representation of one of our items as XML. The representation must be sufficient to /** Get a representation of one of our items as XML. The representation must be sufficient to
* restore the item's state later; an ID is ok if someone else is storing the item state, * restore the item's state later; an ID is ok if someone else is storing the item state,
* otherwise it needs to be the full state. The supplied node is an <Add> or <Remove> * otherwise it needs to be the full state. The supplied node is an \<Add\> or \<Remove\>
* which this method can either add properties or children to. * which this method can either add properties or children to.
*/ */
virtual void get_content_as_xml (typename ChangeContainer::value_type, XMLNode &) const = 0; virtual void get_content_as_xml (typename ChangeContainer::value_type, XMLNode &) const = 0;
@ -211,7 +211,7 @@ class SequenceProperty : public PropertyBase
return p; return p;
} }
/** Given an <Add> or <Remove> node as passed into get_content_to_xml, obtain an item */ /** Given an \<Add\> or \<Remove\> node as passed into get_content_to_xml, obtain an item */
virtual typename Container::value_type get_content_from_xml (XMLNode const & node) const = 0; virtual typename Container::value_type get_content_from_xml (XMLNode const & node) const = 0;
void clear_owned_changes () { void clear_owned_changes () {

2
libs/pbd/pbd/sndfile_manager.h
View File

@ -34,7 +34,7 @@ namespace PBD {
class SndFileDescriptor : public FileDescriptor class SndFileDescriptor : public FileDescriptor
{ {
public: public:
SndFileDescriptor (std::string const &, bool, SF_INFO *); SndFileDescriptor (std::string const & file_name, bool writeable, SF_INFO* info);
~SndFileDescriptor (); ~SndFileDescriptor ();
SNDFILE* allocate (); SNDFILE* allocate ();

16
libs/pbd/sndfile_manager.cc
View File

@ -17,6 +17,10 @@
*/ */
/** @file libs/pbd/sndfile_manager.cc
* @brief A FileDescriptor for files opened using libsndfile.
*/
#include <sys/time.h> #include <sys/time.h>
#include <sys/resource.h> #include <sys/resource.h>
#include <sys/types.h> #include <sys/types.h>
@ -31,15 +35,15 @@
using namespace std; using namespace std;
using namespace PBD; using namespace PBD;
/** @param n Filename. /** @param file_name Filename.
* @param w true to open writeable, otherwise false. * @param writeable true to open writeable, otherwise false.
* @param i SF_INFO for the file. * @param info SF_INFO for the file.
*/ */
SndFileDescriptor::SndFileDescriptor (string const & n, bool w, SF_INFO* i) SndFileDescriptor::SndFileDescriptor (string const & file_name, bool writeable, SF_INFO* info)
: FileDescriptor (n, w) : FileDescriptor (file_name, writeable)
, _sndfile (0) , _sndfile (0)
, _info (i) , _info (info)
{ {
manager()->add (this); manager()->add (this);
} }

2
libs/pbd/stateful.cc
View File

@ -178,7 +178,7 @@ Stateful::get_changes_as_properties (Command* cmd) const
} }
/** Set our property values from an XML node. /** Set our property values from an XML node.
* Derived types can call this from ::set_state() (or elsewhere) * Derived types can call this from set_state() (or elsewhere)
* to get basic property setting done. * to get basic property setting done.
* @return IDs of properties that were changed. * @return IDs of properties that were changed.
*/ */