Changes between Version 1 and Version 2 of CodeDocumentation

Timestamp:

Jun 13, 2013, 7:44:35 AM (11 years ago)

Author:

Piotrek Koszuliński

Comment:

--

CodeDocumentation

@@ -119 +119 @@
 * Private classes by default won't be visible in the packages tree.
 * Good example of difference between "mixins" and "extends" is that ```CKEDITOR.event``` is mixed in various other classes and ```CKEDITOR.dom.*``` structure is based on extending parent classes.
-* Constructor is in fact separate documentation "instance", because it will be listed with methods. Thus, it may have its own {{{@private}}}, but it has to be placed below it, because everything before will be the part of class description. However two {{{@private}}} tags in one comment won't be accepted by JSLinter, so the doc then should be split into two comments.
+* Constructor is in fact a separate documentation "instance", because it will be listed with methods. Thus, it may have its own {{{@private}}}, but it has to be placed below it, because everything before will be the part of class description. However two {{{@private}}} tags in one comment won't be accepted by JSLinter, so the doc then should be split into two comments.
 
     Another conclusion is that constructor may be declared completely independently from class, what's useful when {{{CKEDITOR.tools.createClass}}} has been used.
@@ -249 +249 @@
 
 * Use {{{@event}}} instead of {{{@method}}} - usually you'll have to provide the name.
-* {{{@returns}}} isn't accepted and {{{@private}}} and {{{@static}}} may not work (haven't been tested).
+* {{{@returns}}} isn't accepted.
 
 == Various rules ==
 
 * Always leave one blank line between textual comment and the first tag.
-* Separate all block (paragraphs, code samples, etc) with one blank line.
-* Code samples indent with at least two tabs after {{{'*'}}}.
-* Wrapped lines of multiline lists indent with five (default 1 + additional 4) spaces.
+* Separate all block (paragraphs, code samples, etc.) with one blank line.
+* Code samples indent with at least two tabs after {{{'*'}}} and remember - **no spaces**.
 * Always place dot {{{'.'}}} at the end of the sentence. Sentence starts with upper-case letter.
 * Always use single quotes for JS strings, but double quotes for cites, irony, etc. in textual comments.