diff options
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 { |