summaryrefslogtreecommitdiffstats
path: root/lib/changelog.sh
diff options
context:
space:
mode:
authorPatrick McDermott <patrick.mcdermott@libiquity.com>2018-12-27 00:50:32 (EST)
committer Patrick McDermott <patrick.mcdermott@libiquity.com>2018-12-27 00:50:32 (EST)
commit3378cca582b82bfdac2fdb2e104093f6abc46d3a (patch)
tree1fd9731d9fe3a4017b31a44742d897d943356c5b /lib/changelog.sh
parentae3cc9d37fca0e3f6aefdab206a2ad97dc030684 (diff)
ob_parse_changelog(), ob_parse_dep(): Write some documentation
Diffstat (limited to 'lib/changelog.sh')
-rw-r--r--lib/changelog.sh10
1 files changed, 10 insertions, 0 deletions
diff --git a/lib/changelog.sh b/lib/changelog.sh
index aea567c..9dd86fa 100644
--- a/lib/changelog.sh
+++ b/lib/changelog.sh
@@ -63,6 +63,16 @@ _ob_get_changelog_expect_str()
return 0
}
+:<<=cut
+=head1 NAME
+=head1 SYNOPSIS
+=head1 DESCRIPTION
+=head1 RETURN VALUE
+=cut
+## @brief Parse a changelog file
+## @operand file req The file to parse, or "-" for standard input.
+## @operand entry_cb req Callback to run for each entry.
+## @return Returns 0.
ob_parse_changelog()
{
local file=