commit-gnuradio
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Commit-gnuradio] [gnuradio] 44/50: docs: cleaning up some doxygen warni


From: git
Subject: [Commit-gnuradio] [gnuradio] 44/50: docs: cleaning up some doxygen warnings and formatting.
Date: Wed, 15 Apr 2015 21:07:57 +0000 (UTC)

This is an automated email from the git hooks/post-receive script.

jcorgan pushed a commit to branch master
in repository gnuradio.

commit b0d7b7da51c0dcc3cd2d6752de7c30177db0070f
Author: Tom Rondeau <address@hidden>
Date:   Wed Mar 11 10:05:11 2015 -0400

    docs: cleaning up some doxygen warnings and formatting.
---
 gnuradio-runtime/include/gnuradio/prefs.h | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/gnuradio-runtime/include/gnuradio/prefs.h 
b/gnuradio-runtime/include/gnuradio/prefs.h
index 8049be7..4dc92b3 100644
--- a/gnuradio-runtime/include/gnuradio/prefs.h
+++ b/gnuradio-runtime/include/gnuradio/prefs.h
@@ -50,14 +50,16 @@ namespace gr {
     /*!
      * \brief Creates an object to read preference files.
      *
-     * \detail
+     * \details
      *
      * If no file name is given (empty arg list or ""), this opens up
      * the standard GNU Radio configuration files in
      * prefix/etc/gnuradio/conf.d as well as ~/.gnuradio/config.conf.
      *
      * Only access this through the singleton defined here:
+     * \code
      * prefs *p = prefs::singleton();
+     * \endcode
      */
     prefs();
 
@@ -68,9 +70,11 @@ namespace gr {
      * configuration file of the standard form containing sections and
      * key-value pairs:
      *
+     * \code
      * [SectionName]
      * key0 = value0
      * key1 = value1
+     * \endcode
      */
     void add_config_file(const std::string &configfile);
 



reply via email to

[Prev in Thread] Current Thread [Next in Thread]