1.1 --- a/docs/wiki/Cache Sat Jul 21 23:19:26 2018 +0200
1.2 +++ b/docs/wiki/Cache Fri Aug 17 11:41:28 2018 +0200
1.3 @@ -1,6 +1,13 @@
1.4 = Inspection Cache Files =
1.5
1.6 -The results of inspection for each module are written out to cache files, and these files should be able to provide all the information that is gathered during inspection without having to inspect the source code again. One minor benefit of using cached data, instead of having to parse and inspect the source code for a given module, is that of a slightly reduced processing time for the inspection activity. However, an arguably greater benefit is that of being able to see the outcome of the activity as a summary of accumulated data.
1.7 +The results of inspection for each module are written out to cache files, and
1.8 +these files should be able to provide all the information that is gathered
1.9 +during inspection without having to inspect the source code again. One minor
1.10 +benefit of using cached data, instead of having to parse and inspect the
1.11 +source code for a given module, is that of a slightly reduced processing time
1.12 +for the inspection activity. However, an arguably greater benefit is that of
1.13 +being able to see the outcome of the activity as a summary of accumulated
1.14 +data.
1.15
1.16 Each cache file has the following general format:
1.17
1.18 @@ -34,7 +41,8 @@
1.19 ...
1.20
1.21 }}}
1.22 -|| Special name and corresponding reference plus comma-separated list of usage namespaces
1.23 +|| Special name and corresponding reference plus comma-separated list of usage
1.24 +.. namespaces
1.25 ==
1.26 {{{
1.27 members:
1.28 @@ -115,7 +123,8 @@
1.29
1.30 }}}
1.31 ||
1.32 -Comma-separated parameter definitions for each function, with each definition being of the form...
1.33 +Comma-separated parameter definitions for each function, with each definition
1.34 +being of the form...
1.35 {{{
1.36 <name>=<references>
1.37 }}}
1.38 @@ -144,7 +153,10 @@
1.39
1.40 }}}
1.41 ||
1.42 -Attribute usage details for the given name in the given namespace, with usages being a semicolon-separated list of usage alternatives, each being a comma-separated list of attribute names or {} (meaning no attribute names used), attribute names employing ! if invoked
1.43 +Attribute usage details for the given name in the given namespace, with usages
1.44 +being a semicolon-separated list of usage alternatives, each being a
1.45 +comma-separated list of attribute names or {} (meaning no attribute names
1.46 +used), attribute names employing ! if invoked
1.47 ==
1.48 {{{
1.49 attribute accesses:
1.50 @@ -160,7 +172,9 @@
1.51 ...
1.52
1.53 }}}
1.54 -|| Identity of the given attribute chain in the given namespace, with any unresolved attribute chain provided
1.55 +||
1.56 +Identity of the given attribute chain in the given namespace, with any
1.57 +unresolved attribute chain provided
1.58 ==
1.59 {{{
1.60 attribute access usage:
1.61 @@ -168,7 +182,9 @@
1.62 ...
1.63
1.64 }}}
1.65 -|| Indicates, for each access involving the given name and first attribute name in the given namespace, the definitions that may provide the name
1.66 +||
1.67 +Indicates, for each access involving the given name and first attribute name
1.68 +in the given namespace, the definitions that may provide the name
1.69 ==
1.70 {{{
1.71 attribute access-modifiers:
1.72 @@ -176,7 +192,10 @@
1.73 ...
1.74
1.75 }}}
1.76 -|| Indicates, for accesses involving the given name and first attribute name in the given namespace, the modifiers applying to each access, where = indicates assignment, ! indicates invocation, and _ indicates access
1.77 +||
1.78 +Indicates, for accesses involving the given name and first attribute name in
1.79 +the given namespace, the modifiers applying to each access, where = indicates
1.80 +assignment, ! indicates invocation, and _ indicates access
1.81 ==
1.82 {{{
1.83 constant literals:
1.84 @@ -184,7 +203,9 @@
1.85 ...
1.86
1.87 }}}
1.88 -|| Describes a constant literal in the given namespace having the indicated type, encoding (if a string), and value
1.89 +||
1.90 +Describes a constant literal in the given namespace having the indicated type,
1.91 +encoding (if a string), and value
1.92 ==
1.93 {{{
1.94 constant values: