Skip to content

Commit 610b442

Browse files
committed
Remove unnecessary Cil module prefix from Cil module docs
1 parent 4a268c2 commit 610b442

File tree

2 files changed

+250
-250
lines changed

2 files changed

+250
-250
lines changed

src/cil.ml

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ type file =
149149
(** An optional global initializer function. This is a function where
150150
you can put stuff that must be executed before the program is
151151
started. This function, is conceptually at the end of the file,
152-
although it is not part of the globals list. Use {!Cil.getGlobInit}
152+
although it is not part of the globals list. Use {!getGlobInit}
153153
to create/get one. *)
154154
mutable globinitcalled: bool;
155155
(** Whether the global initialization function is called in main. This
@@ -220,9 +220,9 @@ and global =
220220

221221

222222
(** The various types available. Every type is associated with a list of
223-
attributes, which are always kept in sorted order. Use {!Cil.addAttribute}
224-
and {!Cil.addAttributes} to construct list of attributes. If you want to
225-
inspect a type, you should use {!Cil.unrollType} to see through the uses
223+
attributes, which are always kept in sorted order. Use {!addAttribute}
224+
and {!addAttributes} to construct list of attributes. If you want to
225+
inspect a type, you should use {!unrollType} to see through the uses
226226
of named types. *)
227227
and typ =
228228
TVoid of attributes (** Void type *)
@@ -242,7 +242,7 @@ and typ =
242242
and name attributes of the formal arguments ([None] if no
243243
arguments were specified, as in a function whose definition or
244244
prototype we have not seen; [Some \[\]] means void). Use
245-
{!Cil.argsToList} to obtain a list of arguments. The boolean
245+
{!argsToList} to obtain a list of arguments. The boolean
246246
indicates if it is a variable-argument function. If this is the
247247
type of a varinfo for which we have a function declaration then
248248
the information for the formals must match that in the
@@ -254,7 +254,7 @@ and typ =
254254
in the file by a [GType] global. This is printed as just the
255255
type name. The actual referred type is not printed here and is
256256
carried only to simplify processing. To see through a sequence
257-
of named type references, use {!Cil.unrollType}. The attributes
257+
of named type references, use {!unrollType}. The attributes
258258
are in addition to those given when the type name was defined. *)
259259

260260
| TComp of compinfo * attributes
@@ -338,19 +338,19 @@ and attrparam =
338338

339339

340340
(** Information about a composite type (a struct or a union). Use
341-
{!Cil.mkCompInfo}
341+
{!mkCompInfo}
342342
to create non-recursive or (potentially) recursive versions of this. Make
343343
sure you have a [GCompTag] for each one of these. *)
344344
and compinfo = {
345345
mutable cstruct: bool; (** True if struct, False if union *)
346346
mutable cname: string; (** The name. Always non-empty. Use
347-
{!Cil.compFullName} to get the
347+
{!compFullName} to get the
348348
full name of a comp (along with
349349
the struct or union) *)
350350
mutable ckey: int; (** A unique integer constructed from
351351
the name. Use {!Hashtbl.hash} on
352352
the string returned by
353-
{!Cil.compFullName}. All compinfo
353+
{!compFullName}. All compinfo
354354
for a given key are shared. *)
355355
mutable cfields: fieldinfo list; (** Information about the fields *)
356356
mutable cattr: attributes; (** The attributes that are defined at
@@ -370,7 +370,7 @@ and fieldinfo = {
370370
compinfo for a given id *)
371371
mutable fname: string; (** The name of the field. Might be
372372
the value of
373-
{!Cil.missingFieldName} in which
373+
{!missingFieldName} in which
374374
case it must be a bitfield and is
375375
not printed and it does not
376376
participate in initialization *)
@@ -417,8 +417,8 @@ and typeinfo = {
417417

418418
(** Information about a variable. These structures are shared by all
419419
references to the variable. So, you can change the name easily, for
420-
example. Use one of the {!Cil.makeLocalVar}, {!Cil.makeTempVar} or
421-
{!Cil.makeGlobalVar} to create instances of this data structure. *)
420+
example. Use one of the {!makeLocalVar}, {!makeTempVar} or
421+
{!makeGlobalVar} to create instances of this data structure. *)
422422
and varinfo = {
423423
mutable vname: string; (** The name of the variable. Cannot
424424
be empty. *)
@@ -523,9 +523,9 @@ and exp =
523523
| Question of exp * exp * exp * typ
524524
(** (a ? b : c) operation. Includes
525525
the type of the result *)
526-
| CastE of typ * exp (** Use {!Cil.mkCast} to make casts *)
526+
| CastE of typ * exp (** Use {!mkCast} to make casts *)
527527

528-
| AddrOf of lval (** Always use {!Cil.mkAddrOf} to
528+
| AddrOf of lval (** Always use {!mkAddrOf} to
529529
construct one of these. Apply to an
530530
lvalue of type [T] yields an
531531
expression of type [TPtr(T)] *)
@@ -548,7 +548,7 @@ and constant =
548548
| CInt of cilint * ikind * string option
549549
(** Integer constant. Give the ikind (see ISO9899 6.1.3.2)
550550
and the textual representation, if available. Use
551-
{!Cil.integer} or {!Cil.kinteger} to create these. *)
551+
{!integer} or {!kinteger} to create these. *)
552552
| CStr of string * encoding (** String constant (of pointer type) *)
553553
| CWStr of int64 list * wstring_type (** Wide string constant (of type "wchar_t *") *)
554554
| CChr of char (** Character constant. This has type int, so use
@@ -560,7 +560,7 @@ and constant =
560560
if available *)
561561
| CEnum of exp * string * enuminfo
562562
(** An enumeration constant with the given value, name, from the given
563-
enuminfo. This is not used if {!Cil.lowerEnum} is false (default).
563+
enuminfo. This is not used if {!lowerEnum} is false (default).
564564
Use {!Cillower.lowerEnumVisitor} to replace these with integer
565565
constants. *)
566566

@@ -615,7 +615,7 @@ and binop =
615615
and lval =
616616
lhost * offset
617617

618-
(** The host part of an {!Cil.lval}. *)
618+
(** The host part of an {!lval}. *)
619619
and lhost =
620620
| Var of varinfo
621621
(** The host is a variable. *)
@@ -625,7 +625,7 @@ and lhost =
625625
[TPtr(T)]. *)
626626

627627

628-
(** The offset part of an {!Cil.lval}. Each offset can be applied to certain
628+
(** The offset part of an {!lval}. Each offset can be applied to certain
629629
kinds of lvalues and its effect is that it advances the starting address
630630
of the lvalue and changes the denoted type, essentially focussing to some
631631
smaller lvalue that is contained in the original one. *)
@@ -658,7 +658,7 @@ and offset =
658658
(* AddrOf (Mem a, NoOffset) = a *)
659659

660660
(** Initializers for global variables. You can create an initializer with
661-
{!Cil.makeZeroInit}. *)
661+
{!makeZeroInit}. *)
662662
and init =
663663
| SingleInit of exp (** A single initializer *)
664664
| CompoundInit of typ * (offset * init) list
@@ -673,7 +673,7 @@ and init =
673673
For unions there must be exactly one initializer. If
674674
the initializer is not for the first field then a field
675675
designator is printed. You can scan an initializer list with
676-
{!Cil.foldLeftCompound}. *)
676+
{!foldLeftCompound}. *)
677677

678678
(** We want to be able to update an initializer in a global variable, so we
679679
define it as a mutable field *)
@@ -691,8 +691,8 @@ and fundec =
691691
varinfo. *)
692692
mutable sformals: varinfo list;
693693
(** Formals. These must be shared with the formals that appear in the
694-
type of the function. Use {!Cil.setFormals} or
695-
{!Cil.setFunctionType} to set these
694+
type of the function. Use {!setFormals} or
695+
{!setFunctionType} to set these
696696
formals and ensure that they are reflected in the function type.
697697
Do not make copies of these because the body refers to them. *)
698698
mutable slocals: varinfo list;
@@ -704,8 +704,8 @@ and fundec =
704704
in this function, if we have
705705
computed it. range = 0 ...
706706
(smaxstmtid-1). This is computed by
707-
{!Cil.computeCFGInfo}. *)
708-
mutable sallstmts: stmt list; (** After you call {!Cil.computeCFGInfo}
707+
{!computeCFGInfo}. *)
708+
mutable sallstmts: stmt list; (** After you call {!computeCFGInfo}
709709
this field is set to contain all
710710
statements in the function *)
711711
}
@@ -737,7 +737,7 @@ and stmt = {
737737
and the context in which this
738738
statement appears *)
739739
mutable preds: stmt list; (** The inverse of the succs function*)
740-
mutable fallthrough: stmt option; (** The fallthrough successor statement computed from the context of this statement in {!Cil.computeCFGInto}. Useful for the syntactic successor of Goto and Loop. *)
740+
mutable fallthrough: stmt option; (** The fallthrough successor statement computed from the context of this statement in {!computeCFGInto}. Useful for the syntactic successor of Goto and Loop. *)
741741
}
742742

743743
(** Labels *)
@@ -968,7 +968,7 @@ type 'a visitAction =
968968
one of Change... actions if you want to copy the node *)
969969

970970
(** A visitor interface for traversing CIL trees. Create instantiations of
971-
this type by specializing the class {!Cil.nopCilVisitor}. *)
971+
this type by specializing the class {!nopCilVisitor}. *)
972972
class type cilVisitor = object
973973

974974
method vvdec: varinfo -> varinfo visitAction
@@ -2526,7 +2526,7 @@ and bitsOffset (baset: typ) (off: offset) : int * int =
25262526

25272527
(** Do constant folding on an expression. If the first argument is true then
25282528
will also compute compiler-dependent expressions such as sizeof.
2529-
See also {!Cil.constFoldVisitor}, which will run constFold on all
2529+
See also {!constFoldVisitor}, which will run constFold on all
25302530
expressions in a given AST node.*)
25312531
and constFold (machdep: bool) (e: exp) : exp =
25322532
match e with
@@ -3175,7 +3175,7 @@ let pTypeSig : (typ -> typsig) ref =
31753175

31763176

31773177
(** A printer interface for CIL trees. Create instantiations of
3178-
this type by specializing the class {!Cil.defaultCilPrinter}. *)
3178+
this type by specializing the class {!defaultCilPrinter}. *)
31793179
class type cilPrinter = object
31803180

31813181
method setCurrentFormals : varinfo list -> unit
@@ -3203,26 +3203,26 @@ class type cilPrinter = object
32033203

32043204
method pStmt: unit -> stmt -> doc
32053205
(** Control-flow statement. This is used by
3206-
{!Cil.printGlobal} and by {!Cil.dumpGlobal}. *)
3206+
{!printGlobal} and by {!dumpGlobal}. *)
32073207

32083208
method dStmt: out_channel -> int -> stmt -> unit
32093209
(** Dump a control-flow statement to a file with a given indentation. This is used by
3210-
{!Cil.dumpGlobal}. *)
3210+
{!dumpGlobal}. *)
32113211

32123212
method dBlock: out_channel -> int -> block -> unit
32133213
(** Dump a control-flow block to a file with a given indentation. This is
3214-
used by {!Cil.dumpGlobal}. *)
3214+
used by {!dumpGlobal}. *)
32153215

32163216
method pBlock: unit -> block -> Pretty.doc
32173217
(** Print a block. *)
32183218

32193219
method pGlobal: unit -> global -> doc
32203220
(** Global (vars, types, etc.). This can be slow and is used only by
3221-
{!Cil.printGlobal} but by {!Cil.dumpGlobal} for everything else except
3221+
{!printGlobal} but by {!dumpGlobal} for everything else except
32223222
[GVar] and [GFun]. *)
32233223

32243224
method dGlobal: out_channel -> global -> unit
3225-
(** Dump a global to a file. This is used by {!Cil.dumpGlobal}. *)
3225+
(** Dump a global to a file. This is used by {!dumpGlobal}. *)
32263226

32273227
method pFieldDecl: unit -> fieldinfo -> doc
32283228
(** A field declaration *)
@@ -3256,21 +3256,21 @@ class type cilPrinter = object
32563256

32573257
method pStmtKind : stmt -> unit -> stmtkind -> Pretty.doc
32583258
(** Print a statement kind. The code to be printed is given in the
3259-
{!Cil.stmtkind} argument. The initial {!Cil.stmt} argument
3259+
{!stmtkind} argument. The initial {!stmt} argument
32603260
records the statement which follows the one being printed;
3261-
{!Cil.defaultCilPrinterClass} uses this information to prettify
3261+
{!defaultCilPrinterClass} uses this information to prettify
32623262
statement printing in certain special cases. *)
32633263

32643264
method pExp: unit -> exp -> doc
32653265
(** Print expressions *)
32663266

32673267
method pInit: unit -> init -> doc
32683268
(** Print initializers. This can be slow and is used by
3269-
{!Cil.printGlobal} but not by {!Cil.dumpGlobal}. *)
3269+
{!printGlobal} but not by {!dumpGlobal}. *)
32703270

32713271
method dInit: out_channel -> int -> init -> unit
32723272
(** Dump a global to a file with a given indentation. This is used by
3273-
{!Cil.dumpGlobal}. *)
3273+
{!dumpGlobal}. *)
32743274
end
32753275

32763276

@@ -5026,9 +5026,9 @@ let saveBinaryFile (cil_file : file) (filename : string) =
50265026
saveBinaryFileChannel cil_file outchan;
50275027
close_out outchan
50285028

5029-
(** Read a {!Cil.file} in binary form from the filesystem. The first
5029+
(** Read a {!file} in binary form from the filesystem. The first
50305030
argument is the name of a file previously created by
5031-
{!Cil.saveBinaryFile}. Because this also reads some global state,
5031+
{!saveBinaryFile}. Because this also reads some global state,
50325032
this should be called before any other CIL code is parsed or generated. *)
50335033
let loadBinaryFile (filename : string) : file =
50345034
let inchan = open_in_bin filename in
@@ -6930,5 +6930,5 @@ let d_formatarg () = function
69306930
(* ------------------------------------------------------------------------- *)
69316931

69326932
(** Deprecated. For compatibility with older programs, these are
6933-
aliases for {!Cil.builtinFunctions} *)
6933+
aliases for {!builtinFunctions} *)
69346934
let gccBuiltins = builtinFunctions

0 commit comments

Comments
 (0)