[pacman-dev] [PATCH 2/2] Docs docs docs and more docs

[Allan McRae]

On 26/1/20 5:01 pm, morganamilo wrote:
> Write docs for every public alpm member and expand on the existing
> documentation for other members.
> 
> ---
> 
> The entire .h file has basically been restructed. The best way to see
> the end result is either to read the generated man pages or enabled html
> and view the generated html.
> 
> Also note alpm_list is still not documented.

I have not gone through all the content yet, but here is a few things I
noticed when apply and building docs:

Applying: Docs docs docs and more docs
.git/rebase-apply/patch:220: trailing whitespace.
/** Returns the current error code from the handle.
.git/rebase-apply/patch:683: trailing whitespace.
/** A database is missing
.git/rebase-apply/patch:760: trailing whitespace.
/** Event callback.
.git/rebase-apply/patch:1010: trailing whitespace.
/** Sets the callback used for logging.
.git/rebase-apply/patch:1023: trailing whitespace.
/** Returns the callback used to report download progress.
warning: squelched 2 whitespace errors
warning: 7 lines add whitespace errors.


/home/allan/arch/code/pacman/lib/libalpm/alpm_list.h:40: warning: group
alpm_list: ignoring title "ALPM List" that does not match old title
"List Functions"


/home/allan/arch/code/pacman/lib/libalpm/alpm.h:1128: warning: Found
unknown command '\parama'
/home/allan/arch/code/pacman/lib/libalpm/alpm.h:1597: warning: unable to
resolve link to 'alpm_siglevel_t' for \link command

(not sure if that last one is due to this patch)


Looks like our Doxyfile.in could be updated.  Probably could restrict
the files it makes documentation for if everything is going to alpm.h
and alpm_list.h.

> +/**
> + * @file alpm.h
> + * @author Pacman Development Team
> + * @date 26 Jan 2020
> + * @brief Arch Linux Package Manager Library
> + *
> + * bork
> + */
> +


Can we get rid of the date?  It is like to become outdated with the next
patch...

Also, bork?


Allan