Another minor pass of Doxygen cleanup.

(bzr r10659)

1 files changed, 55 insertions, 41 deletions

diff --git a/src/uri.cpp b/src/uri.cpp
index 1e38c034a..a5aec6f2d 100644
--- a/src/uri.cpp
+++ b/src/uri.cpp
@@ -1,6 +1,6 @@
 /**
  * \file
- * \brief Classes for representing and manipulating URIs as per RFC 2396.
+ * Classes for representing and manipulating URIs as per RFC 2396.
  *
  * Authors:
  *   MenTaLguY <mental@rydia.net>
@@ -17,14 +17,18 @@
 
 namespace Inkscape {
 
-/** \brief Copy constructor. */
+/**
+ * Copy constructor.
+ */
 URI::URI(const URI &uri) {
     uri._impl->reference();
     _impl = uri._impl;
 }
 
-/** \brief Constructor from a C-style ASCII string.
-    \param preformed Properly quoted C-style string to be represented.
+/**
+ * Constructor from a C-style ASCII string.
+ *
+ * @param preformed Properly quoted C-style string to be represented.
  */
 URI::URI(gchar const *preformed) throw(BadURIException) {
     xmlURIPtr uri;
@@ -39,12 +43,16 @@ URI::URI(gchar const *preformed) throw(BadURIException) {
 }
 
 
-/** \brief Destructor. */
+/**
+ * Destructor.
+ */
 URI::~URI() {
     _impl->unreference();
 }
 
-/** \brief Assignment operator. */
+/**
+ * Assignment operator.
+ */
 URI &URI::operator=(URI const &uri) {
 // No check for self-assignment needed, as _impl refcounting increments first.
     uri._impl->reference();
@@ -77,32 +85,35 @@ void URI::Impl::unreference() {
     }
 }
 
-/** \fn bool URI::isOpaque() const
-    \brief Determines if the URI represented is an 'opaque' URI.
-    \return \c true if the URI is opaque, \c false if hierarchial.
-*/
+/**
+ * Determines if the URI represented is an 'opaque' URI.
+ *
+ * @return \c true if the URI is opaque, \c false if hierarchial.
+ */
 bool URI::Impl::isOpaque() const {
     bool opq = !isRelative() && (getOpaque() != NULL);
     return opq;
 }
 
-/** \fn bool URI::isRelative() const
-    \brief Determines if the URI represented is 'relative' as per RFC 2396.
-    \return \c true if the URI is relative, \c false if it is absolute.
-
-    Relative URI references are distinguished by not begining with a
-    scheme name.
-*/
+/**
+ * Determines if the URI represented is 'relative' as per RFC 2396.
+ *
+ * Relative URI references are distinguished by not begining with a
+ * scheme name.
+ *
+ * @return \c true if the URI is relative, \c false if it is absolute.
+ */
 bool URI::Impl::isRelative() const {
     return !_uri->scheme;
 }
 
-/** \fn bool URI::isNetPath() const
-    \brief Determines if the relative URI represented is a 'net-path' as per RFC 2396.
-    \return \c true if the URI is relative and a net-path, \c false otherwise.
-
-    A net-path is one that starts with "\\".
-*/
+/**
+ * Determines if the relative URI represented is a 'net-path' as per RFC 2396.
+ *
+ * A net-path is one that starts with "\\".
+ *
+ * @return \c true if the URI is relative and a net-path, \c false otherwise.
+ */
 bool URI::Impl::isNetPath() const {
     bool isNet = false;
     if ( isRelative() )
@@ -113,12 +124,13 @@ bool URI::Impl::isNetPath() const {
     return isNet;
 }
 
-/** \fn bool URI::isRelativePath() const
-    \brief Determines if the relative URI represented is a 'relative-path' as per RFC 2396.
-    \return \c true if the URI is relative and a relative-path, \c false otherwise.
-
-    A relative-path is one that starts with no slashes.
-*/
+/**
+ * Determines if the relative URI represented is a 'relative-path' as per RFC 2396.
+ *
+ * A relative-path is one that starts with no slashes.
+ *
+ * @return \c true if the URI is relative and a relative-path, \c false otherwise.
+ */
 bool URI::Impl::isRelativePath() const {
     bool isRel = false;
     if ( isRelative() )
@@ -129,12 +141,13 @@ bool URI::Impl::isRelativePath() const {
     return isRel;
 }
 
-/** \fn bool URI::isAbsolutePath() const
-    \brief Determines if the relative URI represented is a 'absolute-path' as per RFC 2396.
-    \return \c true if the URI is relative and an absolute-path, \c false otherwise.
-
-    An absolute-path is one that starts with a single "\".
-*/
+/**
+ * Determines if the relative URI represented is a 'absolute-path' as per RFC 2396.
+ *
+ * An absolute-path is one that starts with a single "\".
+ *
+ * @return \c true if the URI is relative and an absolute-path, \c false otherwise.
+ */
 bool URI::Impl::isAbsolutePath() const {
     bool isAbs = false;
     if ( isRelative() )
@@ -230,12 +243,13 @@ URI URI::from_native_filename(gchar const *path) throw(BadURIException) {
     return result;
 }
 
-/** \fn gchar *URI::toString() const
-    \brief Returns a glib string version of this URI.
-    \return a glib string version of this URI.
-
-    The returned string must be freed with \c g_free().
-*/
+/**
+ * Returns a glib string version of this URI.
+ *
+ * The returned string must be freed with \c g_free().
+ *
+ * @return a glib string version of this URI.
+ */
 gchar *URI::Impl::toString() const {
     xmlChar *string = xmlSaveUri(_uri);
     if (string) {