qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Christian Schoenebeck <qemu_oss@crudebyte.com>
To: qemu-devel@nongnu.org, Peter Maydell <peter.maydell@linaro.org>
Cc: Greg Kurz <groug@kaod.org>
Subject: [PULL 14/19] 9pfs/9p.h: convert Doxygen -> kerneldoc format
Date: Fri, 04 Mar 2022 13:27:49 +0100	[thread overview]
Message-ID: <c2ae4952afd4f0bab98cd6e2803b5190804f52ad.1646396869.git.qemu_oss@crudebyte.com> (raw)
In-Reply-To: <cover.1646396869.git.qemu_oss@crudebyte.com>

API doc comments in QEMU are supposed to be in kerneldoc format, so
convert API doc comments from Doxygen format to kerneldoc format.

Based-on: <E1nPTwO-0006pl-Np@lizzy.crudebyte.com>
Signed-off-by: Christian Schoenebeck <qemu_oss@crudebyte.com>
Reviewed-by: Greg Kurz <groug@kaod.org>
Message-Id: <2b8f91de7bac3d3bc85d60eb08830a35a394be75.1646314856.git.qemu_oss@crudebyte.com>
---
 hw/9pfs/9p.h | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/hw/9pfs/9p.h b/hw/9pfs/9p.h
index 94b273b3d0..af2635fae9 100644
--- a/hw/9pfs/9p.h
+++ b/hw/9pfs/9p.h
@@ -100,8 +100,8 @@ typedef enum P9ProtoVersion {
     V9FS_PROTO_2000L = 0x02,
 } P9ProtoVersion;
 
-/**
- * @brief Minimum message size supported by this 9pfs server.
+/*
+ * Minimum message size supported by this 9pfs server.
  *
  * A client establishes a session by sending a Tversion request along with a
  * 'msize' parameter which suggests the server a maximum message size ever to be
@@ -231,7 +231,7 @@ static inline void v9fs_readdir_init(P9ProtoVersion proto_version, V9fsDir *dir)
     }
 }
 
-/**
+/*
  * Type for 9p fs drivers' (a.k.a. 9p backends) result of readdir requests,
  * which is a chained list of directory entries.
  */
@@ -289,8 +289,8 @@ typedef enum AffixType_t {
     AffixType_Suffix, /* A.k.a. postfix. */
 } AffixType_t;
 
-/**
- * @brief Unique affix of variable length.
+/*
+ * Unique affix of variable length.
  *
  * An affix is (currently) either a suffix or a prefix, which is either
  * going to be prepended (prefix) or appended (suffix) with some other
@@ -304,7 +304,7 @@ typedef struct VariLenAffix {
     AffixType_t type; /* Whether this affix is a suffix or a prefix. */
     uint64_t value; /* Actual numerical value of this affix. */
     /*
-     * Lenght of the affix, that is how many (of the lowest) bits of @c value
+     * Lenght of the affix, that is how many (of the lowest) bits of ``value``
      * must be used for appending/prepending this affix to its final resulting,
      * unique number.
      */
-- 
2.20.1



  reply	other threads:[~2022-03-04 13:50 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-04 12:27 [PULL 00/19] 9p queue 2022-03-04 Christian Schoenebeck
2022-03-04 12:27 ` Christian Schoenebeck [this message]
2022-03-04 12:27 ` [PULL 19/19] fsdev/p9array.h: convert Doxygen -> kerneldoc format Christian Schoenebeck
2022-03-04 12:27 ` [PULL 01/19] 9p: linux: Fix a couple Linux assumptions Christian Schoenebeck
2022-03-04 12:27 ` [PULL 04/19] 9p: darwin: Handle struct dirent differences Christian Schoenebeck
2022-03-04 12:27 ` [PULL 18/19] 9pfs/coth.h: drop Doxygen format on v9fs_co_run_in_worker() Christian Schoenebeck
2022-03-04 12:27 ` [PULL 16/19] 9pfs/9p.c: convert Doxygen -> kerneldoc format Christian Schoenebeck
2022-03-04 12:27 ` [PULL 09/19] 9p: darwin: Implement compatibility for mknodat Christian Schoenebeck
2022-03-04 12:27 ` [PULL 02/19] 9p: Rename 9p-util -> 9p-util-linux Christian Schoenebeck
2022-03-04 12:27 ` [PULL 13/19] 9pfs: drop Doxygen format from qemu_dirent_dup() API comment Christian Schoenebeck
2022-03-04 12:27 ` [PULL 11/19] 9p: darwin: meson: Allow VirtFS on Darwin Christian Schoenebeck
2022-03-04 12:27 ` [PULL 12/19] 9pfs: move qemu_dirent_dup() from osdep -> 9p-util Christian Schoenebeck
2022-03-04 12:27 ` [PULL 15/19] 9pfs/codir.c: convert Doxygen -> kerneldoc format Christian Schoenebeck
2022-03-04 12:27 ` [PULL 10/19] 9p: darwin: Adjust assumption on virtio-9p-test Christian Schoenebeck
2022-03-04 12:27 ` [PULL 07/19] 9p: darwin: *xattr_nofollow implementations Christian Schoenebeck
2022-03-04 12:27 ` [PULL 17/19] 9pfs/9p-util.h: convert Doxygen -> kerneldoc format Christian Schoenebeck
2022-03-04 12:27 ` [PULL 06/19] 9p: darwin: Move XATTR_SIZE_MAX->P9_XATTR_SIZE_MAX Christian Schoenebeck
2022-03-04 12:27 ` [PULL 08/19] 9p: darwin: Compatibility for f/l*xattr Christian Schoenebeck
2022-03-04 12:27 ` [PULL 03/19] 9p: darwin: Handle struct stat(fs) differences Christian Schoenebeck
2022-03-04 12:27 ` [PULL 05/19] 9p: darwin: Ignore O_{NOATIME, DIRECT} Christian Schoenebeck
2022-03-04 18:42 ` [PULL 00/19] 9p queue 2022-03-04 Peter Maydell
2022-03-04 20:16   ` Christian Schoenebeck
2022-03-04 21:31     ` Will Cohen
2022-03-06 20:59       ` Will Cohen
2022-03-07  9:47         ` Christian Schoenebeck
2022-03-07 10:05       ` Greg Kurz

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=c2ae4952afd4f0bab98cd6e2803b5190804f52ad.1646396869.git.qemu_oss@crudebyte.com \
    --to=qemu_oss@crudebyte.com \
    --cc=groug@kaod.org \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-devel@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).