-
Notifications
You must be signed in to change notification settings - Fork 133
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
// show how to add descriptions with classes and functions | ||
// using @doc; descriptions added in this manner are associatd | ||
// with respective classes and functions and will appear in the | ||
// .help() runtime info mechanism, as well as in documentation | ||
// generated using CKDoc. | ||
// | ||
// requires: chuck-1.5.4.4 or higher | ||
|
||
class Foo | ||
{ | ||
// add inline documenation (processed at compile-time) | ||
@doc "this is a description for the class Foo" | ||
|
||
fun void bar() | ||
{ | ||
// add inline documenation (processed at compile-time) | ||
@doc "a function in Foo, bar() likes calling his friends" | ||
} | ||
} | ||
// print runtime info about Foo: | ||
// can see the above @doc descriptions in the class info | ||
// (will also appear in documentation generated by CKDoc) | ||
Foo.help(); |