mirror of
https://github.com/tbsdtv/linux_media.git
synced 2025-07-23 20:51:03 +02:00
Minor fixes to kernel-doc.rst
The author clearly meant to use the word 'which' here. Also replace some tabs with spaces which fixes the syntax highlighting in my editor. Signed-off-by: Matthew Wilcox <mawilcox@microsoft.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
committed by
Jonathan Corbet
parent
da70b8c475
commit
dcb50d979e
@@ -277,7 +277,7 @@ named ``Return``.
|
|||||||
|
|
||||||
#) If the descriptive text you provide has lines that begin with
|
#) If the descriptive text you provide has lines that begin with
|
||||||
some phrase followed by a colon, each of those phrases will be taken
|
some phrase followed by a colon, each of those phrases will be taken
|
||||||
as a new section heading, with probably won't produce the desired
|
as a new section heading, which probably won't produce the desired
|
||||||
effect.
|
effect.
|
||||||
|
|
||||||
Structure, union, and enumeration documentation
|
Structure, union, and enumeration documentation
|
||||||
@@ -324,22 +324,22 @@ It is possible to document nested structs unions, like::
|
|||||||
struct {
|
struct {
|
||||||
int arg1;
|
int arg1;
|
||||||
int arg2;
|
int arg2;
|
||||||
}
|
}
|
||||||
struct {
|
struct {
|
||||||
void *arg3;
|
void *arg3;
|
||||||
int arg4;
|
int arg4;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
union {
|
union {
|
||||||
struct {
|
struct {
|
||||||
int arg1;
|
int arg1;
|
||||||
int arg2;
|
int arg2;
|
||||||
} st1;
|
} st1;
|
||||||
struct {
|
struct {
|
||||||
void *arg1;
|
void *arg1;
|
||||||
int arg2;
|
int arg2;
|
||||||
} st2;
|
} st2;
|
||||||
} bar;
|
} bar;
|
||||||
};
|
};
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
Reference in New Issue
Block a user