ob_parse_changelog(), ob_parse_dep(): Write some documentation

2 files changed, 34 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=
diff --git a/lib/deps.sh b/lib/deps.sh
index babf84d..c33585f 100644
--- a/lib/deps.sh
+++ b/lib/deps.sh
@@ -17,6 +17,30 @@
 # You should have received a copy of the GNU General Public License
 # along with opkbuild.  If not, see <http://www.gnu.org/licenses/>.
 
+## @brief Parse a single package dependency string
+## @option -p pkg_var      The name of the variable in which to store the
+##                         package name.
+## @option -q archqual_var The name of the variable in which to store the
+##                         architecture qualifier, if any.
+## @option -r rel_var      The name of the variable in which to store the
+##                         relationship operator, if any.
+## @option -v ver_var      The name of the variable in which to store the
+##                         version, if any.
+## @option -A arches_var   The name of the variable in which to store the
+##                         architectures, if any.
+## @option -l plats_var    The name of the variable in which to store the
+##                         platforms, if any.
+## @option -a host_arch    The host architecture.  If given, the dependency will
+##                         only be printed on standard output if it applies to
+##                         the given architecture.
+## @option -a host_plat    The host platform.  If given, the dependency will
+##                         only be printed on standard output if it applies to
+##                         the given platform.
+## @operand dep req The dependency to parse.
+## @details \fBob_parse_dep\fP() parses package dependencies in the format
+##          \fIpkg:archqual (rel ver) [arches] <plats>\fP, where all components
+##          are optional except \fIpkg\fP.
+## @return Returns 0.
 ob_parse_dep()
 {
 	local opt=