About example/app:
This is docstring for the example/app package.
The package contains a function which does it's job by applying transformation to the first and second arguments:
When you mention a function like that, it is included into the package description and removed from the "Other functions..." section
The package contains a function which does it's job by applying transformation to the first and second arguments:
Function foo (first &key (other 100500))
Arguments:
- first -- Just a first argument.
- other -- Optional keyword argument. Default is 100500.
Returns:
A string with first and other concatenated.
Details:
This is example function.
Internally it calls example/utils:do-the-job to do the real job.
Note, that the link above is broken, but Coo does not warn us when building the docs. Sphinx issues a warning inn such case.
Internally it calls example/utils:do-the-job to do the real job.
Note, that the link above is broken, but Coo does not warn us when building the docs. Sphinx issues a warning inn such case.
See also:
When you mention a function like that, it is included into the package description and removed from the "Other functions..." section
About example/class:
This package demonstrates how ATDOC displays classes and generic functions.
The key consept is user class:
email --
last-login-at --
name --
It is possible to check if user has admin privileges, using this function:
Right now, is-admin returns t only for objects of admin:
The key consept is user class:
Class user
Superclasses:
common-lisp:standard-object, sb-pcl::slot-object, common-lisp:t
Documented Subclasses:
Direct Slots:
Details:
All users in the system have this class.
Last login slot is updated automatically.
NOTE: "Documented Subclasses" section contains only classes which are:
Last login slot is updated automatically.
NOTE: "Documented Subclasses" section contains only classes which are:
It is possible to check if user has admin privileges, using this function:
Function is-admin (user)
Details:
Returns t if user can modify the system.
Right now, is-admin returns t only for objects of admin:
Class admin
Superclasses:
user, common-lisp:standard-object, sb-pcl::slot-object, common-lisp:t
Documented Subclasses:
None
Direct Slots:
None
Details:
Admins should have additional priveleges.
About example/utils:
The utils package.
This package's docstring is not mention any functions via aboutfun or aboutclass tags.
Hence, the only exported function do-the-job will be show in a separate section "Other functions in example/utils".
This package's docstring is not mention any functions via aboutfun or aboutclass tags.
Hence, the only exported function do-the-job will be show in a separate section "Other functions in example/utils".
Other classes in example/class
Class non-documented-user
Superclasses:
user, common-lisp:standard-object, sb-pcl::slot-object, common-lisp:t
Documented Subclasses:
None
Direct Slots:
None
No documentation string. Possibly unimplemented or incomplete.
Other functions in example/utils
Function do-the-job (first second)
Details:
The function does the job.
It concatenates first and second arguments calling internal function concat.
On this multiline we'll check how does documentationsystem processes docstrings.
It concatenates first and second arguments calling internal function concat.
On this multiline we'll check how does documentationsystem processes docstrings.
Index of exported symbols
| example/class: | admin, class |
| example/utils: | do-the-job, function |
| example/app: | foo, function |
| example/class: | non-documented-user, class (undocumented) |
| example/class: | user, class |