This report is about lines denoted as documentation comments (prefixed with "# ")
which should actually be file comments (prefixed with "##").
I do realize that reporting this might seem rather picky, so here is the point:
The interface file can be parsed and contains a documentation comment for almost
every feature. In short, you could parse the interface file, generate some dummy
code and then use some tool like NDoc or Sandcastle Builder to produce some
documentation for it.
I hopefully managed to add a screenshot to this report. This should give you
some first impression of a possible result.
At this point it should be obvious that a parser can't prevent these non-documentation
comments from appearing in the generated documentation files. So the following
lines should be prefixed with another "#".
246: # Shapes used for outlining column.
261: # Invisible mark that only sets the line background colour.
275: # Markers used for outlining column.
1498+: # These are like their namesakes Home(Extend) ...
1660: # Constants for use with SetVisiblePolicy
2416: # Notifications
unclear => looks like some kind of a "group header"
2449+: # For compatibility, these go through the ...
2457+: # Symbolic key codes and modifier flags.
2492: # For SciLexer.h
2720: # XML and ASP
2729: # More HTML
2731: # X-Code
2733: # SGML
2773: # Embedded VBScript
2782: # ASP VBScript
2791: # Embedded Python
2805: # PHP
2807: # ASP Python
2821: # PHP
4384: # Events
4391: # GTK+ Specific to work around focus and accelerator problems
unclear => refers to the Key-event only?
1684: # Caret policy, used by SetXCaretPolicy ...
- seems to be a documentation comment for "enu CaretPolicy"
- move the comment up one line
4473: # Deprecated in 2.30
- documentation comments relate to the succeeding feature only
- copy and paste to SetUsePalette
These were only those lines that caught my eye. There might be more...
Log in to post a comment.