[pacman-dev,02/23] doc: add doc header to alpm.h

Message ID 20201207221956.667322-3-morganamilo@archlinux.org
State Accepted, archived
Headers show
Series Docs Docs Docs 2: electric boogaloo | expand

Commit Message

morganamilo Dec. 7, 2020, 10:19 p.m. UTC
---
 lib/libalpm/alpm.h | 13 +++++++++++++
 1 file changed, 13 insertions(+)

Comments

Colin Woodbury Dec. 9, 2020, 7:29 p.m. UTC | #1
Spelling of "primarily".

On Mon, 7 Dec 2020, at 14:19, morganamilo wrote:
> ---
> lib/libalpm/alpm.h | 13 +++++++++++++
> 1 file changed, 13 insertions(+)
> 
> diff --git a/lib/libalpm/alpm.h b/lib/libalpm/alpm.h
> index 50c4bb6b..48ba7fdc 100644
> --- a/lib/libalpm/alpm.h
> +++ b/lib/libalpm/alpm.h
> @@ -20,6 +20,19 @@
>   *  You should have received a copy of the GNU General Public License
>   *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
>   */
> +
> +/**
> + * @file alpm.h
> + * @author Pacman Development Team
> + * @date 7 Dec 2020
> + * @brief Arch Linux Package Manager Library
> + */
> +
> +/** @mainpage alpm
> + *
> + * libalpm is a package management library, primaraly used by pacman.
> + */
> +
> #ifndef ALPM_H
> #define ALPM_H
>  
> -- 
> 2.29.2
>
morganamilo Dec. 12, 2020, 3:12 a.m. UTC | #2
On 09/12/2020 19:29, Colin Woodbury wrote:
> Spelling of "primarily".
> 
> On Mon, 7 Dec 2020, at 14:19, morganamilo wrote:
>> ---
>> lib/libalpm/alpm.h | 13 +++++++++++++
>> 1 file changed, 13 insertions(+)
>>
>> diff --git a/lib/libalpm/alpm.h b/lib/libalpm/alpm.h
>> index 50c4bb6b..48ba7fdc 100644
>> --- a/lib/libalpm/alpm.h
>> +++ b/lib/libalpm/alpm.h
>> @@ -20,6 +20,19 @@
>>   *  You should have received a copy of the GNU General Public License
>>   *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
>>   */
>> +
>> +/**
>> + * @file alpm.h
>> + * @author Pacman Development Team
>> + * @date 7 Dec 2020
>> + * @brief Arch Linux Package Manager Library
>> + */
>> +
>> +/** @mainpage alpm
>> + *
>> + * libalpm is a package management library, primaraly used by pacman.
>> + */
>> +
>> #ifndef ALPM_H
>> #define ALPM_H
>>  
>> -- 
>> 2.29.2
>>

Funnily enough I did run a spell checker..

If it's okay with every one, I would rather just merge this as is and
fix up the spelling. (mainly due to my laziness of amending all the
commits).

Once this is merged and everything is in place it's then easy to fix up
the docs without any refactoring.

Patch

diff --git a/lib/libalpm/alpm.h b/lib/libalpm/alpm.h
index 50c4bb6b..48ba7fdc 100644
--- a/lib/libalpm/alpm.h
+++ b/lib/libalpm/alpm.h
@@ -20,6 +20,19 @@ 
  *  You should have received a copy of the GNU General Public License
  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
+
+/**
+ * @file alpm.h
+ * @author Pacman Development Team
+ * @date 7 Dec 2020
+ * @brief Arch Linux Package Manager Library
+ */
+
+/** @mainpage alpm
+ *
+ * libalpm is a package management library, primaraly used by pacman.
+ */
+
 #ifndef ALPM_H
 #define ALPM_H