1.1 --- a/docs/wiki/APIs Sat Jul 21 23:19:26 2018 +0200
1.2 +++ b/docs/wiki/APIs Fri Aug 17 11:41:28 2018 +0200
1.3 @@ -1,25 +1,31 @@
1.4 = APIs =
1.5
1.6 -The principal application programming interfaces (APIs) within Lichen are described below.
1.7 +The principal application programming interfaces (APIs) within Lichen are
1.8 +described below.
1.9
1.10 == Modules ==
1.11
1.12 -When [[../Inspection|inspecting]] and [[../Translation|translating]] modules, common abstractions are used so that elements of the program are handled in similar ways. Various useful attributes and methods are provided by the `CommonModule` abstraction for use within `InspectedModule` and `TranslatedModule` methods:
1.13 +When [[../Inspection|inspecting]] and [[../Translation|translating]] modules,
1.14 +common abstractions are used so that elements of the program are handled in
1.15 +similar ways. Various useful attributes and methods are provided by the
1.16 +`CommonModule` abstraction for use within `InspectedModule` and
1.17 +`TranslatedModule` methods:
1.18
1.19 {{{#!table
1.20 '''Attribute or Method''' || '''Purpose'''
1.21 ==
1.22 -`name` ||
1.23 -An attribute providing the module name.
1.24 +`name` || An attribute providing the module name.
1.25 ==
1.26 -`get_global_path(name)` ||
1.27 -A method returning the qualified name of the given global name within the module being processed.
1.28 +`get_global_path(name)` || A method returning the qualified name of the given
1.29 + .. global name within the module being processed.
1.30 ==
1.31 -`get_namespace_path()` ||
1.32 -A method returning the qualified name of the namespace being processed.
1.33 +`get_namespace_path()` || A method returning the qualified name of the
1.34 + .. namespace being processed.
1.35 +
1.36 * For modules, this is the module name
1.37 - * For classes, functions and methods, the path incorporates the module name and namespaces leading to the current namespace itself
1.38 + * For classes, functions and methods, the path incorporates the module name
1.39 + and namespaces leading to the current namespace itself
1.40 ==
1.41 -`get_object_path(name)` ||
1.42 -A method returning the qualified name of the given local name within the namespace being processed.
1.43 +`get_object_path(name)` || A method returning the qualified name of the given
1.44 + .. local name within the namespace being processed.
1.45 }}}