Repository: lucy-clownfish Updated Branches: refs/heads/master 0c5c166ee -> a6112d69f
Document exposure specifier Project: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/repo Commit: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/commit/f6511096 Tree: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/tree/f6511096 Diff: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/diff/f6511096 Branch: refs/heads/master Commit: f6511096034e44af0b0c26698c882183042771a5 Parents: 0c5c166 Author: Nick Wellnhofer <wellnho...@aevum.de> Authored: Thu Feb 11 16:24:21 2016 +0100 Committer: Nick Wellnhofer <wellnho...@aevum.de> Committed: Thu Feb 11 16:24:21 2016 +0100 ---------------------------------------------------------------------- runtime/core/Clownfish/Docs/WritingClasses.md | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/f6511096/runtime/core/Clownfish/Docs/WritingClasses.md ---------------------------------------------------------------------- diff --git a/runtime/core/Clownfish/Docs/WritingClasses.md b/runtime/core/Clownfish/Docs/WritingClasses.md index c7f5a49..1967bfe 100644 --- a/runtime/core/Clownfish/Docs/WritingClasses.md +++ b/runtime/core/Clownfish/Docs/WritingClasses.md @@ -132,7 +132,7 @@ This will generate: ### Class exposure -TODO +API documentation will only be generated for classes with public exposure. ### Inert classes @@ -150,10 +150,8 @@ modifier. Final classes must not be inherited from. Variables are declared with a declaration of the following form: - variable-declaration = variable-exposure-specifier? - variable-modifier* + variable-declaration = variable-modifier* type variable-name ";" - variable-exposure-specifier = "public" variable-modifier = "inert" variable-name = identifier @@ -179,10 +177,6 @@ definition will look like: int Path_max_path_length = 5000; -### Inert variable exposure - -TODO - ### Instance variables Non-inert variables are instance variables and added to the class's ivars @@ -246,7 +240,7 @@ Example using short names: ### Function exposure -TODO +API documentation will only be generated for functions with public exposure. ### Inert functions