summaryrefslogtreecommitdiff
path: root/gcell
diff options
context:
space:
mode:
authoreb2009-05-22 21:22:22 +0000
committereb2009-05-22 21:22:22 +0000
commit5a4b9ba9af590b2a269cb3e5872c85faa7c284d1 (patch)
tree2049863d006e7bf3265d16975f8a784ef7ad1407 /gcell
parentc6935bf1775ae73edf525376b79aeafc05f673b1 (diff)
downloadgnuradio-5a4b9ba9af590b2a269cb3e5872c85faa7c284d1.tar.gz
gnuradio-5a4b9ba9af590b2a269cb3e5872c85faa7c284d1.tar.bz2
gnuradio-5a4b9ba9af590b2a269cb3e5872c85faa7c284d1.zip
Doc fixes.
git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@11088 221aa14e-8319-0410-a670-987f0aec2ac5
Diffstat (limited to 'gcell')
-rw-r--r--gcell/include/gcell/gc_job_desc.h1
-rw-r--r--gcell/include/gcell/gc_job_manager.h9
-rw-r--r--gcell/lib/runtime/gc_job_manager_impl.h8
3 files changed, 10 insertions, 8 deletions
diff --git a/gcell/include/gcell/gc_job_desc.h b/gcell/include/gcell/gc_job_desc.h
index 5ff99e2e2..7dc9d182c 100644
--- a/gcell/include/gcell/gc_job_desc.h
+++ b/gcell/include/gcell/gc_job_desc.h
@@ -171,6 +171,7 @@ typedef struct gc_job_ea_args {
/*!
* \brief "job description" that is DMA'd to/from the SPE.
+ * \ingroup gcell
*/
typedef struct gc_job_desc
{
diff --git a/gcell/include/gcell/gc_job_manager.h b/gcell/include/gcell/gc_job_manager.h
index 67abce7ed..8e5de5217 100644
--- a/gcell/include/gcell/gc_job_manager.h
+++ b/gcell/include/gcell/gc_job_manager.h
@@ -149,6 +149,7 @@ gc_make_job_manager(const gc_jm_options *options = 0);
/*!
* \brief Abstract class that manages SPE jobs.
+ * \ingroup gcell
*
* There is typically a single instance derived from this class.
* It is safe to call its methods from any thread.
@@ -211,10 +212,10 @@ public:
/*!
* \brief wait for 1 or more jobs to complete.
*
- * \param[input] njobs is the length of arrays \p jd and \p done.
- * \param[input] jd are the jobs that are to be waited for.
- * \param[output] done indicates whether the corresponding job is complete.
- * \param[input] mode indicates whether to wait for ALL or ANY of the jobs
+ * \param[in] njobs is the length of arrays \p jd and \p done.
+ * \param[in] jd are the jobs that are to be waited for.
+ * \param[out] done indicates whether the corresponding job is complete.
+ * \param[in] mode indicates whether to wait for ALL or ANY of the jobs
* in \p jd to complete.
*
* A thread may only wait for jobs which it submitted.
diff --git a/gcell/lib/runtime/gc_job_manager_impl.h b/gcell/lib/runtime/gc_job_manager_impl.h
index 07dcabaf2..a56117870 100644
--- a/gcell/lib/runtime/gc_job_manager_impl.h
+++ b/gcell/lib/runtime/gc_job_manager_impl.h
@@ -248,10 +248,10 @@ public:
/*!
* \brief wait for 1 or more jobs to complete.
*
- * \param[input] njobs is the length of arrays \p jd and \p done.
- * \param[input] jd are the jobs that are to be waited for.
- * \param[output] done indicates whether the corresponding job is complete.
- * \param[input] mode indicates whether to wait for ALL or ANY of the jobs
+ * \param[in] njobs is the length of arrays \p jd and \p done.
+ * \param[in] jd are the jobs that are to be waited for.
+ * \param[out] done indicates whether the corresponding job is complete.
+ * \param[in] mode indicates whether to wait for ALL or ANY of the jobs
* in \p jd to complete.
*
* A thread may only wait for jobs which it submitted.