Assorted doxygen fixes; no functional changes.

git-svn-id: svn://localhost/ardour2/branches/3.0@9575 d708f5d6-7413-0410-9779-e7cbd77b26cf

doc/Doxyfile

@@ -523,7 +523,7 @@ WARNINGS               = YES
 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
 # 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 
 # 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 
 # 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 
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 

gtk2_ardour/editor_snapshots.cc

@@ -108,7 +108,7 @@ EditorSnapshots::button_press (GdkEventButton* ev)
 /** Pop up the snapshot display context menu.
  * @param button Button used to open the menu.
  * @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
 EditorSnapshots::popup_context_menu (int button, int32_t time, std::string snapshot_name)

libs/ardour/session_state.cc

@@ -648,7 +648,8 @@ Session::remove_pending_capture_state ()
 }
 
 /** Rename a state file.
- * @param snapshot_name Snapshot name.
+ *  @param old_name Old snapshot name.
+ *  @param new_name New snapshot name.
  */
 void
 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.
- * @param snapshot_name Snapshot name.
+ *  @param snapshot_name Snapshot name.
  */
 void
 Session::remove_state (string snapshot_name)

libs/ardour/tempo.cc

@@ -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.
- *  @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.
  */
 

libs/gtkmm2ext/gtkmm2ext/dndvbox.h

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

libs/pbd/file_manager.cc

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

libs/pbd/pbd/file_manager.h

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

libs/pbd/pbd/search_path.h

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

libs/pbd/pbd/sequence_property.h

@@ -110,7 +110,7 @@ class SequenceProperty : public PropertyBase
 
 	/** 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,
-	 *  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.
 	 */
 	virtual void get_content_as_xml (typename ChangeContainer::value_type, XMLNode &) const = 0;
@@ -211,7 +211,7 @@ class SequenceProperty : public PropertyBase
 		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;
 
 	void clear_owned_changes () {

libs/pbd/pbd/sndfile_manager.h

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

libs/pbd/sndfile_manager.cc

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

libs/pbd/stateful.cc

@@ -178,7 +178,7 @@ Stateful::get_changes_as_properties (Command* cmd) const
 }
 
 /** 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.
  *  @return IDs of properties that were changed.
  */