[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Commit-gnuradio] r11025 - in gnuradio/branches/developers/eb/t367: docs
|
From: |
eb |
|
Subject: |
[Commit-gnuradio] r11025 - in gnuradio/branches/developers/eb/t367: docs/doxygen gnuradio-core/src/lib/gengen gr-audio-portaudio/src mblock/src/include/mblock mblock/src/lib pmt/src/lib |
|
Date: |
Wed, 13 May 2009 21:27:33 -0600 (MDT) |
Author: eb
Date: 2009-05-13 21:27:32 -0600 (Wed, 13 May 2009)
New Revision: 11025
Modified:
gnuradio/branches/developers/eb/t367/docs/doxygen/Doxyfile.in
gnuradio/branches/developers/eb/t367/gnuradio-core/src/lib/gengen/gr_moving_average_XX.h.t
gnuradio/branches/developers/eb/t367/gr-audio-portaudio/src/audio_portaudio_sink.h
gnuradio/branches/developers/eb/t367/gr-audio-portaudio/src/audio_portaudio_source.h
gnuradio/branches/developers/eb/t367/mblock/src/include/mblock/mblock.h
gnuradio/branches/developers/eb/t367/mblock/src/include/mblock/port.h
gnuradio/branches/developers/eb/t367/mblock/src/lib/mb_mblock_impl.h
gnuradio/branches/developers/eb/t367/mblock/src/lib/mb_port_simple.h
gnuradio/branches/developers/eb/t367/mblock/src/lib/mb_runtime_base.h
gnuradio/branches/developers/eb/t367/mblock/src/lib/mb_runtime_thread_per_block.h
gnuradio/branches/developers/eb/t367/mblock/src/lib/mb_worker.h
gnuradio/branches/developers/eb/t367/pmt/src/lib/pmt.h
Log:
doc fixes. looking better.
Modified: gnuradio/branches/developers/eb/t367/docs/doxygen/Doxyfile.in
===================================================================
--- gnuradio/branches/developers/eb/t367/docs/doxygen/Doxyfile.in
2009-05-14 02:18:06 UTC (rev 11024)
+++ gnuradio/branches/developers/eb/t367/docs/doxygen/Doxyfile.in
2009-05-14 03:27:32 UTC (rev 11025)
@@ -193,7 +193,7 @@
# Java. For instance, namespaces will be presented as packages, qualified
# scopes will look different, etc.
-OPTIMIZE_OUTPUT_JAVA = YES
+OPTIMIZE_OUTPUT_JAVA = NO
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources only. Doxygen will then generate output that is more tailored for
@@ -275,7 +275,7 @@
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
# corresponding to a cache size of 2^16 = 65536 symbols
-SYMBOL_CACHE_SIZE = 0
+SYMBOL_CACHE_SIZE = 4
#---------------------------------------------------------------------------
# Build related configuration options
@@ -309,7 +309,7 @@
# the interface are included in the documentation.
# If set to NO (the default) only methods in the interface are included.
-EXTRACT_LOCAL_METHODS = YES
+EXTRACT_LOCAL_METHODS = NO
# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
@@ -408,31 +408,31 @@
# Note: This option applies only to the class list, not to the
# alphabetical list.
-SORT_BY_SCOPE_NAME = YES
+SORT_BY_SCOPE_NAME = NO
# The GENERATE_TODOLIST tag can be used to enable (YES) or
# 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
# commands in the documentation.
-GENERATE_TESTLIST = YES
+GENERATE_TESTLIST = NO
# The GENERATE_BUGLIST tag can be used to enable (YES) or
# 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
# \deprecated commands in the documentation.
-GENERATE_DEPRECATEDLIST= YES
+GENERATE_DEPRECATEDLIST= NO
# The ENABLED_SECTIONS tag can be used to enable conditional
# documentation sections, marked by \if sectionname ... \endif.
@@ -459,7 +459,7 @@
# then setting the SHOW_DIRECTORIES tag to YES will show the directory
hierarchy
# in the documentation. The default is NO.
-SHOW_DIRECTORIES = YES
+SHOW_DIRECTORIES = NO
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
# This will remove the Files entry from the Quick Index and from the
@@ -471,7 +471,7 @@
# Namespaces page. This will remove the Namespaces entry from the Quick Index
# and from the Folder Tree View (if specified). The default is YES.
-SHOW_NAMESPACES = YES
+SHOW_NAMESPACES = NO
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically
from
@@ -570,8 +570,7 @@
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
FILE_PATTERNS = *.h \
- *.dox \
- *.cc
+ *.dox
# 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.
@@ -583,14 +582,12 @@
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT
tag.
-EXCLUDE = @abs_top_builddir@/docs \
- @abs_top_builddir@/docs/doxygen/xml \
+EXCLUDE = @abs_top_builddir@/docs/doxygen/html \
+ @abs_top_builddir@/docs/doxygen/xml \
@abs_top_builddir@/docs/doxygen/xml-swig \
+ @abs_top_builddir@/docs/doxygen/other/doxypy.py \
@abs_top_builddir@/dtools \
@abs_top_builddir@/gcell/ibm \
- @abs_top_builddir@/gnuradio-core/doc/other/doxypy.py \
-
@abs_top_builddir@/gnuradio-core/doc/other/shared_ptr_docstub.h \
-
@abs_top_builddir@/gnuradio-core/doc/other/vector_docstub.h \
@abs_top_builddir@/gnuradio-core/src/lib/bug_work_around_6.cc \
@abs_top_builddir@/gnuradio-core/src/lib/filter/assembly.h \
@abs_top_builddir@/gnuradio-core/src/lib/filter/generate_all.py \
@@ -664,6 +661,7 @@
@abs_top_builddir@/usrp/host/lib/legacy/circular_buffer.h \
@abs_top_builddir@/usrp/host/lib/legacy/circular_linked_list.h \
@abs_top_builddir@/usrp/host/lib/legacy/db_wbx.h \
+ @abs_top_builddir@/usrp/host/lib/legacy/db_wbx.cc \
@abs_top_builddir@/usrp/host/lib/legacy/dump_data.py \
@abs_top_builddir@/usrp/host/lib/legacy/gen_usrp_dbid.py \
@abs_top_builddir@/usrp/host/lib/legacy/usrp_dbid.py \
@@ -784,7 +782,7 @@
# Note: To get rid of all source code in the generated output, make sure also
# VERBATIM_HEADERS is set to NO.
-SOURCE_BROWSER = YES
+SOURCE_BROWSER = NO
# Setting the INLINE_SOURCES tag to YES will include the body
# of functions and classes directly in the documentation.
@@ -1458,7 +1456,7 @@
# indirect implementation dependencies (inheritance, containment, and
# class references variables) of the class with other documented classes.
-COLLABORATION_GRAPH = YES
+COLLABORATION_GRAPH = NO
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for groups, showing the direct groups dependencies
Modified:
gnuradio/branches/developers/eb/t367/gnuradio-core/src/lib/gengen/gr_moving_average_XX.h.t
===================================================================
---
gnuradio/branches/developers/eb/t367/gnuradio-core/src/lib/gengen/gr_moving_average_XX.h.t
2009-05-14 02:18:06 UTC (rev 11024)
+++
gnuradio/branches/developers/eb/t367/gnuradio-core/src/lib/gengen/gr_moving_average_XX.h.t
2009-05-14 03:27:32 UTC (rev 11025)
@@ -35,9 +35,10 @@
/*!
* \brief output is the moving sum of the last N samples, scaled by the scale
factor
- * \ingroup filter. max_iter limits how long we go without flushing the
accumulator
+ * \ingroup filter
+ *
+ * max_iter limits how long we go without flushing the accumulator
* This is necessary to avoid numerical instability for float and complex.
- *
*/
class @NAME@ : public gr_sync_block
{
Modified:
gnuradio/branches/developers/eb/t367/gr-audio-portaudio/src/audio_portaudio_sink.h
===================================================================
---
gnuradio/branches/developers/eb/t367/gr-audio-portaudio/src/audio_portaudio_sink.h
2009-05-14 02:18:06 UTC (rev 11024)
+++
gnuradio/branches/developers/eb/t367/gr-audio-portaudio/src/audio_portaudio_sink.h
2009-05-14 03:27:32 UTC (rev 11025)
@@ -34,7 +34,8 @@
typedef boost::shared_ptr<audio_portaudio_sink> audio_portaudio_sink_sptr;
/*!
- * \PORTAUDIO audio sink.
+ * \brief PORTAUDIO audio sink.
+ *
* \param sampling_rate sampling rate in Hz
* \param dev PORTAUDIO device name, e.g., "pa:"
* \param ok_to_block true if it's ok for us to block
Modified:
gnuradio/branches/developers/eb/t367/gr-audio-portaudio/src/audio_portaudio_source.h
===================================================================
---
gnuradio/branches/developers/eb/t367/gr-audio-portaudio/src/audio_portaudio_source.h
2009-05-14 02:18:06 UTC (rev 11024)
+++
gnuradio/branches/developers/eb/t367/gr-audio-portaudio/src/audio_portaudio_source.h
2009-05-14 03:27:32 UTC (rev 11025)
@@ -34,7 +34,8 @@
typedef boost::shared_ptr<audio_portaudio_source> audio_portaudio_source_sptr;
/*!
- * \PORTAUDIO audio source.
+ * \brief PORTAUDIO audio source.
+ *
* \param sampling_rate sampling rate in Hz
* \param dev PORTAUDIO device name, e.g., "pa:"
* \param ok_to_block true if it's ok for us to block
Modified:
gnuradio/branches/developers/eb/t367/mblock/src/include/mblock/mblock.h
===================================================================
--- gnuradio/branches/developers/eb/t367/mblock/src/include/mblock/mblock.h
2009-05-14 02:18:06 UTC (rev 11024)
+++ gnuradio/branches/developers/eb/t367/mblock/src/include/mblock/mblock.h
2009-05-14 03:27:32 UTC (rev 11025)
@@ -307,7 +307,7 @@
walk_tree(mb_visitor *visitor);
- //! \implementation
+ //! \internal
// internal use only
mb_mblock_impl_sptr
impl() const { return d_impl; }
Modified: gnuradio/branches/developers/eb/t367/mblock/src/include/mblock/port.h
===================================================================
--- gnuradio/branches/developers/eb/t367/mblock/src/include/mblock/port.h
2009-05-14 02:18:06 UTC (rev 11024)
+++ gnuradio/branches/developers/eb/t367/mblock/src/include/mblock/port.h
2009-05-14 03:27:32 UTC (rev 11025)
@@ -85,7 +85,7 @@
/*
* \brief Invalidate any cached peer resolutions
- * \implementation
+ * \internal
*/
virtual void invalidate_cache() = 0;
};
Modified: gnuradio/branches/developers/eb/t367/mblock/src/lib/mb_mblock_impl.h
===================================================================
--- gnuradio/branches/developers/eb/t367/mblock/src/lib/mb_mblock_impl.h
2009-05-14 02:18:06 UTC (rev 11024)
+++ gnuradio/branches/developers/eb/t367/mblock/src/lib/mb_mblock_impl.h
2009-05-14 03:27:32 UTC (rev 11025)
@@ -216,7 +216,7 @@
/*!
* \brief walk mblock tree and invalidate all port resolution caches.
- * \implementation
+ * \internal
*/
void
invalidate_all_port_caches();
Modified: gnuradio/branches/developers/eb/t367/mblock/src/lib/mb_port_simple.h
===================================================================
--- gnuradio/branches/developers/eb/t367/mblock/src/lib/mb_port_simple.h
2009-05-14 02:18:06 UTC (rev 11024)
+++ gnuradio/branches/developers/eb/t367/mblock/src/lib/mb_port_simple.h
2009-05-14 03:27:32 UTC (rev 11025)
@@ -63,7 +63,7 @@
/*
* \brief Invalidate any cached peer resolutions
- * \implementation
+ * \internal
*/
void invalidate_cache();
Modified: gnuradio/branches/developers/eb/t367/mblock/src/lib/mb_runtime_base.h
===================================================================
--- gnuradio/branches/developers/eb/t367/mblock/src/lib/mb_runtime_base.h
2009-05-14 02:18:06 UTC (rev 11024)
+++ gnuradio/branches/developers/eb/t367/mblock/src/lib/mb_runtime_base.h
2009-05-14 03:27:32 UTC (rev 11025)
@@ -40,13 +40,13 @@
/*!
* \brief lock the big runtime lock
- * \implementation
+ * \internal
*/
inline void lock() { d_brl.lock(); }
/*!
* \brief unlock the big runtime lock
- * \implementation
+ * \internal
*/
inline void unlock() { d_brl.unlock(); }
Modified:
gnuradio/branches/developers/eb/t367/mblock/src/lib/mb_runtime_thread_per_block.h
===================================================================
---
gnuradio/branches/developers/eb/t367/mblock/src/lib/mb_runtime_thread_per_block.h
2009-05-14 02:18:06 UTC (rev 11024)
+++
gnuradio/branches/developers/eb/t367/mblock/src/lib/mb_runtime_thread_per_block.h
2009-05-14 03:27:32 UTC (rev 11025)
@@ -28,7 +28,7 @@
/*!
* \brief Concrete runtime that uses a thread per mblock
- * \implementation
+ * \internal
*
* These are all implementation details.
*/
Modified: gnuradio/branches/developers/eb/t367/mblock/src/lib/mb_worker.h
===================================================================
--- gnuradio/branches/developers/eb/t367/mblock/src/lib/mb_worker.h
2009-05-14 02:18:06 UTC (rev 11024)
+++ gnuradio/branches/developers/eb/t367/mblock/src/lib/mb_worker.h
2009-05-14 03:27:32 UTC (rev 11025)
@@ -34,7 +34,7 @@
/*!
* \brief Worker thread for thread_per_block runtime
- * \implementation
+ * \internal
*/
class mb_worker : public omni_thread
{
Modified: gnuradio/branches/developers/eb/t367/pmt/src/lib/pmt.h
===================================================================
--- gnuradio/branches/developers/eb/t367/pmt/src/lib/pmt.h 2009-05-14
02:18:06 UTC (rev 11024)
+++ gnuradio/branches/developers/eb/t367/pmt/src/lib/pmt.h 2009-05-14
03:27:32 UTC (rev 11025)
@@ -1,6 +1,6 @@
/* -*- c++ -*- */
/*
- * Copyright 2006 Free Software Foundation, Inc.
+ * Copyright 2006,2009 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
@@ -83,19 +83,19 @@
* I.e., there is a single false value, #f.
* ------------------------------------------------------------------------
*/
-extern const pmt_t PMT_T; //< #t : boolean true constant
-extern const pmt_t PMT_F; //< #f : boolean false constant
+extern const pmt_t PMT_T; //< \#t : boolean true constant
+extern const pmt_t PMT_F; //< \#f : boolean false constant
-//! Return true if obj is #t or #f, else return false.
+//! Return true if obj is \#t or \#f, else return false.
bool pmt_is_bool(pmt_t obj);
-//! Return false if obj is #f, else return true.
+//! Return false if obj is \#f, else return true.
bool pmt_is_true(pmt_t obj);
-//! Return true if obj is #f, else return true.
+//! Return true if obj is \#f, else return true.
bool pmt_is_false(pmt_t obj);
-//! Return #f is val is false, else return #t.
+//! Return \#f is val is false, else return \#t.
pmt_t pmt_from_bool(bool val);
//! Return true if val is PMT_T, return false when val is PMT_F,
@@ -457,7 +457,7 @@
* <pre>
* eqv returns true if:
* x and y are the same object.
- * x and y are both #t or both #f.
+ * x and y are both \#t or both \#f.
* x and y are both symbols and their names are the same.
* x and y are both numbers, and are numerically equal.
* x and y are both the empty list (nil).
@@ -483,7 +483,7 @@
* and return that pair.
*
* \p alist (for "association list") must be a list of pairs. If no pair
- * in \p alist has \p obj as its car then #f is returned.
+ * in \p alist has \p obj as its car then \#f is returned.
* Uses pmt_eq to compare \p obj with car fields of the pairs in \p alist.
*/
pmt_t pmt_assq(pmt_t obj, pmt_t alist);
@@ -493,7 +493,7 @@
* and return that pair.
*
* \p alist (for "association list") must be a list of pairs. If no pair
- * in \p alist has \p obj as its car then #f is returned.
+ * in \p alist has \p obj as its car then \#f is returned.
* Uses pmt_eqv to compare \p obj with car fields of the pairs in \p alist.
*/
pmt_t pmt_assv(pmt_t obj, pmt_t alist);
@@ -503,7 +503,7 @@
* and return that pair.
*
* \p alist (for "association list") must be a list of pairs. If no pair
- * in \p alist has \p obj as its car then #f is returned.
+ * in \p alist has \p obj as its car then \#f is returned.
* Uses pmt_equal to compare \p obj with car fields of the pairs in \p alist.
*/
pmt_t pmt_assoc(pmt_t obj, pmt_t alist);
@@ -553,21 +553,21 @@
/*!
* \brief Return the first sublist of \p list whose car is \p obj.
- * If \p obj does not occur in \p list, then #f is returned.
+ * If \p obj does not occur in \p list, then \#f is returned.
* pmt_memq use pmt_eq to compare \p obj with the elements of \p list.
*/
pmt_t pmt_memq(pmt_t obj, pmt_t list);
/*!
* \brief Return the first sublist of \p list whose car is \p obj.
- * If \p obj does not occur in \p list, then #f is returned.
+ * If \p obj does not occur in \p list, then \#f is returned.
* pmt_memv use pmt_eqv to compare \p obj with the elements of \p list.
*/
pmt_t pmt_memv(pmt_t obj, pmt_t list);
/*!
* \brief Return the first sublist of \p list whose car is \p obj.
- * If \p obj does not occur in \p list, then #f is returned.
+ * If \p obj does not occur in \p list, then \#f is returned.
* pmt_member use pmt_equal to compare \p obj with the elements of \p list.
*/
pmt_t pmt_member(pmt_t obj, pmt_t list);
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Commit-gnuradio] r11025 - in gnuradio/branches/developers/eb/t367: docs/doxygen gnuradio-core/src/lib/gengen gr-audio-portaudio/src mblock/src/include/mblock mblock/src/lib pmt/src/lib,
eb <=