From patchwork Mon Dec 7 22:19:54 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: morganamilo X-Patchwork-Id: 1827 Return-Path: Delivered-To: patchwork@archlinux.org Received: from apollo.archlinux.org (localhost [127.0.0.1]) by apollo.archlinux.org (Postfix) with ESMTP id C84AE1C998D26 for ; Mon, 7 Dec 2020 23:11:31 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on apollo.archlinux.org X-Spam-Level: X-Spam-Status: No, score=-0.6 required=5.0 tests=DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1,DKIM_VALID=-0.1,DKIM_VALID_AU=-0.1, LOCAL_FAKEBUSINESS=0.5,MAILING_LIST_MULTI=-1,SPF_HELO_PASS=-0.001, T_DMARC_POLICY_NONE=0.01 autolearn=ham autolearn_force=no version=3.4.4 X-Spam-BL-Results: Received: from mail.archlinux.org (mail.archlinux.org [IPv6:2a01:4f9:c010:3052::1]) by apollo.archlinux.org (Postfix) with ESMTPS for ; Mon, 7 Dec 2020 23:11:31 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=archlinux.org; s=luna2; t=1607379745; bh=RjZYKhycAKVMBaUZ9pRLpFZPdYFoTNyYDSW9CKOUzdc=; h=From:To:Date:In-Reply-To:References:Subject:List-Id: List-Unsubscribe:List-Archive:List-Post:List-Help:List-Subscribe: Reply-To; b=EzdV8NuTd6iwq/3JVQxJ5gtGJkNI1G9GrNwmNMa/a+1T99hPwMVK6w/XhbawtKJJo 4bEg/3ofj13s+O6sUwbmM1xqWa9iwdG20HtDXgbCad33FCFK8BPkmNAaa30OUW1UOC /nSRodQlRMrYPqKO1WR58wN6Ffq8iYBVapVxvyq13siOBGRBJiAzrWv5jK12YKqBQx VnJJDjRfHRoTlrrUCnQL1LAXQ0435fm26E3mo0NB0GBDBI9blWgkarGBwi68dmA6uI tckX8eTaWylSy2Zq/ttWb3gMxbSFbg+EDe8gJtSfuDQpcKXLu7kMxsftz+PodIyLM4 tuEhrpp6pefJyelpUwH7jvyB+89jGI1KqmcesJqBy2sA/QJIaQcGcBF6ZeasoisX0P 84DCVc6z/wVCXZaDljyZjKwUcQaAVHxGpyrSsyyy2Nj2LOpSqlhoHsWno0/riwQ+/i rjDdXjXC2HHFpLNXGqoHRn5C0jG3MlniFxdcbr0N9f9eX3G4T7if/jdXESfjup1J30 eeFe8erjytStrmJxR7TMbStWBklM19l/KeXRN3sc+CvJ2vzH4mu2lfRP5yikN+MTmO RoGm04LQ5oWu8Mw7NIx6FyYnQsgeaj+6ScTnlakml4FyYVeieT31JhNLhw2FsSXb/O gpwZxd/aiKAfQJR/Jcg7Atr4= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=archlinux.org; s=dkim-ed25519; t=1607382688; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=doRmfxiDcLHIxbl88kYLK+pq/i3DWDBEAvs8HfKXTNE=; b=/X37cMkene4M8zo8ILHHo8LWHKbKVRNZ2CQQ4MI8awEg5HX/njcjUnLeR0g9HD+cw6nGD2 2DOExWfN7EZNR3Dw== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=archlinux.org; s=dkim-rsa; t=1607382688; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=doRmfxiDcLHIxbl88kYLK+pq/i3DWDBEAvs8HfKXTNE=; b=RifQfZChskdtjX9W0fB6L4L5gfHaNVQrE+Zk5yrEUNX8OM/ySk0U1NEcnEksKyvfKqM/JK FkdKEUephMiFkANJOfc3cCGE5YmFBWdJDsQXtg0rx4w9dx5wOlZ75UzAIDwIaULRBoKUos +AU29X/RvAFBpS1WmaIc5UmNFWgpENhR0R6JJuzA26AfP0Oh0XoMbOz1HUSszJ3IA6GLa3 DzbzVfv5vXUPRQjECT+glM/0pmVYwDDivSmML6hTnwvmT+aNsDAO+3uUO72abheuEbdsqE yM8ayHr1VbU85GnBae1CYlSoMif7NIHAhfvCnnGDdAxBLaHNUIrAf7atxpQo68mB7hjTCO EAfg/4Gnukh7yF4W+Azzc3thfRAOIB2NZ2plyKc/CuuuHph/pWVWolsuEMbFyFJ2MXKpGS F/mYWrCVefJo7DxOTxyyhYlNS7xm08CWD7kVY4wwS2X7yYhwabRaPjxYFKObisuLbyVX6e 9f6lWDBdK9LnGQ7jBsk39AgcX033Oh9I4BdBEXMsyQ5AC3Jn51PflmqO1CJA68QnoqQNz+ 5fsx7r/MIOMyBOc9raQFbVQ8gtZaN9FtDiHzwX8rWlGkNPy+wmw8B2PbROaaOicirGuHv5 tu+rYlLGJmmd5faIJ3KjxKP0jxqUhfLXRxumsJwsL0tIDqi0FiWtQ= From: morganamilo DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=archlinux.org; s=dkim-rsa; t=1607379739; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=doRmfxiDcLHIxbl88kYLK+pq/i3DWDBEAvs8HfKXTNE=; b=trIZJinVJ6GC5jo7w3mfdqbyd4iFaoKO4IbB2cPcJ9J/cEhLBXL2bidYHqNt6MmPA1QYAL OpeYTU32i844Zi514zWDeETAqrhyf154cEL+l2u7wSpPfWVJKyOmpdYPgzMIlxMRAlFIER qfyEzwgTd1EVdmeAUdo9Lbh+lYW4SHbI1eiokhZ+Ciu0R5NuxrWQzMbaUNBrpAVS3W1rAk CtLV9MelMhV2KXjvCrpDUrKnswsjHljLqK88GGKUP4LK3u4quXfvl86B8kBQ53Ap08azIl NgA3xw2p8NqUZMRUBHrQds7ZqaUwmyZbdt+IInAa6iANo1McylsgfOUCUukLHA1Yjpe/8I MUCWDRaUyG9tXj5p1Y0ncB7lq0+tzUYHWxI26/E0Ggi0NnoCvBiov2pRD8t/hwU5WHxcDr V52vQuShcNFrXJGP9h+e70M+UFUoPwQXLNlOpI/1vqcfpE7E3fL7QihYylzaiJhJacDQtk dFr/DmGRh/F62kuBAbpab0BxBrJVvW7xsXhX6wLFVQ5naaGBcrzf/0b4nRroXuJyJFze3b DfM0EoPZsopCW5SGJdIrTnmNAnbKc+0B+ZpecX1PtKuIXZTR58w3XZrGxh2IQwxZxtE6v+ +M6opavbvHpFQKle0gse2kh4txWheS3scjlfb1aTK/cguH85+YVmY= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=archlinux.org; s=dkim-ed25519; t=1607379739; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=doRmfxiDcLHIxbl88kYLK+pq/i3DWDBEAvs8HfKXTNE=; b=uXrntmogqbnF4BMVZjmwCriqeLVXoEoB5lNHP8y8Tstx/srld9qZkSZJR1qMk15DMbNjki zyynetP33qOXI6Dg== To: pacman-dev@archlinux.org Date: Mon, 7 Dec 2020 22:19:54 +0000 Message-Id: <20201207221956.667322-22-morganamilo@archlinux.org> X-Mailer: git-send-email 2.29.2 In-Reply-To: <20201207221956.667322-1-morganamilo@archlinux.org> References: <20201207221956.667322-1-morganamilo@archlinux.org> MIME-Version: 1.0 Subject: [pacman-dev] [PATCH 21/23] doc: add extra documentation to the man page X-BeenThere: pacman-dev@archlinux.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Discussion list for pacman development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Discussion list for pacman development Errors-To: pacman-dev-bounces@archlinux.org Sender: "pacman-dev" Authentication-Results: mail.archlinux.org; auth=pass smtp.auth=luna smtp.mailfrom=pacman-dev-bounces@archlinux.org --- lib/libalpm/alpm.h | 10 ++++++++-- lib/libalpm/alpm_list.h | 10 ++++++++++ 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/lib/libalpm/alpm.h b/lib/libalpm/alpm.h index a0de9b13..b2772f19 100644 --- a/lib/libalpm/alpm.h +++ b/lib/libalpm/alpm.h @@ -50,8 +50,14 @@ extern "C" { #include -/** @addtogroup alpm alpm - * @brief The libalpm Public API +/** @addtogroup alpm The libalpm Public API + * + * @section see_also See Also + * \b alpm_list(3), + * \b alpm-hooks(5), + * \b makepkg(8), + * \b pacman(8), + * \b pacman.conf(5) * @{ */ diff --git a/lib/libalpm/alpm_list.h b/lib/libalpm/alpm_list.h index 1eac3043..01fa092c 100644 --- a/lib/libalpm/alpm_list.h +++ b/lib/libalpm/alpm_list.h @@ -24,6 +24,16 @@ * @author Pacman Development Team * @date 7 Dec 2020 * @brief A doubly linked list for use with libalpm + * + * @section see_also See Also + * \b alpm(3), + * \b alpm-hooks(5), + * \b makepkg(8), + * \b pacman(8), + * \b pacman.conf(5) + * @{ + */ + */ #ifndef ALPM_LIST_H