* mdocml: Documented `Db', `El', `Fa', and `Fd'.
@ 2010-06-04 20:57 kristaps
0 siblings, 0 replies; only message in thread
From: kristaps @ 2010-06-04 20:57 UTC (permalink / raw)
To: source
Log Message:
-----------
Documented `Db', `El', `Fa', and `Fd'.
Modified Files:
--------------
mdocml:
mdoc.7
Revision Data
-------------
Index: mdoc.7
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/mdoc.7,v
retrieving revision 1.116
retrieving revision 1.117
diff -Lmdoc.7 -Lmdoc.7 -u -p -r1.116 -r1.117
--- mdoc.7
+++ mdoc.7
@@ -1332,6 +1332,11 @@ See also
and
.Sx \&Dl .
.Ss \&Db
+Start a debugging context.
+This macro is parsed, but generally ignored.
+Its calling syntax is as follows:
+.Pp
+.D1 \. Ns Sx \&Db Cm on | off
.Ss \&Dc
Closes a
.Sx \&Do
@@ -1559,6 +1564,13 @@ and
.Ss \&Ef
.Ss \&Ek
.Ss \&El
+Ends a list context started by
+.Sx \&Bl .
+.Pp
+See also
+.Sx \&Bl
+and
+.Sx \&It .
.Ss \&Em
Denotes text that should be emphasised.
Note that this is a presentation term and should not be used for
@@ -1598,8 +1610,33 @@ is not provided, the document's name as
.Sx \&Nm
is provided.
.Ss \&Fa
+Function argument.
+This may be invoked for names with or without the corresponding type.
+It is also used to specify the field name of a structure.
+Most often, the
+.Sx \&Fa
+macro is used in the
+.Em SYNOPSIS
+section when documenting multi-line function prototypes.
+If invoked with multiple arguments, the arguments are separated by a
+comma.
+Furthermore, if the following macro is another
+.Sx \&Fa ,
+the last argument will also have a trailing comma.
+.Pp
+Examples:
+.D1 \&.Fa \(dqconst char *p\(dq
+.D1 \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq
+.D1 \&.Fa foo
.Ss \&Fc
.Ss \&Fd
+Historically used to document include files.
+This usage has been deprecated in favour of
+.Sx \&In .
+Do not use this macro.
+.Pp
+See also
+.Sx \&In .
.Ss \&Fl
Command-line flag.
Used when listing arguments to command-line utilities.
--
To unsubscribe send an email to source+unsubscribe@mdocml.bsd.lv
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2010-06-04 20:57 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2010-06-04 20:57 mdocml: Documented `Db', `El', `Fa', and `Fd' kristaps
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).