diff options
author | Tavian Barnes <tavianator@gmail.com> | 2010-11-14 21:20:43 -0500 |
---|---|---|
committer | Tavian Barnes <tavianator@gmail.com> | 2010-11-14 21:20:43 -0500 |
commit | 8fe33a340b8979a73fa84f201c15519a9b5d0266 (patch) | |
tree | 12cdbb1c1b9a48f533ab36980602785be1e1deeb /libdimension/progress-impl.h | |
parent | 20a55aa78050d94b187d4edfaac91ea00efea505 (diff) | |
download | dimension-8fe33a340b8979a73fa84f201c15519a9b5d0266.tar.xz |
Document libdimension with Doxygen.
Diffstat (limited to 'libdimension/progress-impl.h')
-rw-r--r-- | libdimension/progress-impl.h | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/libdimension/progress-impl.h b/libdimension/progress-impl.h index ef5ad42..bfb74f6 100644 --- a/libdimension/progress-impl.h +++ b/libdimension/progress-impl.h @@ -18,17 +18,23 @@ * <http://www.gnu.org/licenses/>. * *************************************************************************/ +/** + * @file + * Progress object implementation. + */ + #ifndef DIMENSION_IMPL_PROGRESS_H #define DIMENSION_IMPL_PROGRESS_H -/* Allocate a new progress object */ +/** Allocate a new progress object. */ dmnsn_progress *dmnsn_new_progress(void); -/* Create a new level of loop nesting */ +/** Create a new level of loop nesting. */ void dmnsn_new_progress_element(dmnsn_progress *progress, unsigned int total); -/* Increment the progress counter; should only be called from innermost loop */ +/** Increment the progress counter; should only be called from the innermost + loop. */ void dmnsn_increment_progress(dmnsn_progress *progress); -/* Instantly complete the progress */ +/** Instantly complete the progress. */ void dmnsn_done_progress(dmnsn_progress *progress); struct dmnsn_progress { |