| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| | |
|
| | |
|
| |
|
|
| |
function leads to documentation error
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
When having an example like:
```
## General \PYgen0 docu
#
#
#
#
# General detail \PYgen1 text
# and more
STYLE_TEMPLATE = r'''
\makeatletter
'''
## General \PYgen2 docu
#
#
#
#
#
# General detail \PYgen3 text
# and more
STYLE_TEMPLATE1 = r'''
\makeatletter
'''
```
with
```
EXTRACT_ALL = YES
QUIET = YES
```
we get the warnings (removed doubles and sorted):
```
bb.py:1: warning: Found unknown command '\PYgen0'
bb.py:10: warning: Found unknown command '\PYgen1'
bb.py:12: warning: Found unknown command '\PYgen2'
bb.py:23: warning: Found unknown command '\PYgen3'
```
we see here (especially with `PYgen3` a wrong line number.
After fixing the line count in `pyscanner.l` there was for the second block an offset of 1. This was caused by `commentscan.l` introduced with #7960 after correcting this this offset was also gone.
Revisiting the original example of #7960 showed that here here was also an offset of 1 (probably due to a misinterpretation of where the `<tr>` warning should be mentioned), here it is now also correct..
(The original mismatch was shown of Fossies for the Pygments package)
|
| | |
|
| |\
| |
| | |
Using Python docstrings
|
| | |
| |
| |
| |
| | |
- making documentation a bit clearer
- add configuration setting to have docstrings not as preformatted text but as normal documentation (default remains preformatted).
|
| | | |
|
| | |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
In case we have an empty python comment like: `"""""""` (i.e. 6 double quotes) doxygen will crash in the pyscanner.l version of `stripIndentation`.
```
class Translator(nodes.NodeVisitor):
""""""
## the var
words_and_spaces = re.compile(r'\S+| +|\n')
```
In case of an empty comment we should not call `stripIndentation` and not place `\verbatim` / `\endverbatim` around the empty comment (the later would give an non-understandable empty comment block).
An empty comment should be handled as no comment.
Found by Fossies whilst generating documentation for Mercural 5.5).
|
| | |
| |
| |
| | |
string passed.
|
| |\ \
| | |
| | |
| | | |
https://github.com/albert-github/doxygen into albert-github-feature/issue_7884
|
| | | |
| | |
| | |
| | |
| | |
| | | |
(MARKDOWN_SUPPORT=NO)
Corrected handling of the comment blocks. Due to the possible nesting of classes and the handling of the first line special handling is required by means of the stripping of spaces after a return in a doc block (otherwise it might be stripped away multiple times / left multiple times).
|
| | | | |
|
| | | |
| | |
| | |
| | | |
Explicit counting of the removed newlines at the beginning of a documenation block (markdown.cpp) so this number can be added to get a better line number in case of warnings.
|
| |/ / |
|
| | | |
|
| | |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
In special cases when having multiple documentation section for 1 item in python it is possible that they are concatenated in a wrong way and result in a warning.
Each documentation section should be seen as a separate section and be separated from other sections.
the example:
```
#####################################################################
# # Modify Install Stage ############################################
#####################################################################
class install(_install):
"""Specialised python package installer.
It does some required chown calls in addition to the usual stuff.
"""
```
gives a warning like:
```
warning: unexpected command endverbatim
```
|
| | | |
|
| | | |
|
| |/ |
|
| | |
|
| | |
|
| | |
|
| | |
|
| |
|
|
| |
free issues
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| |\
| |
| | |
Fix typos
|
| | |
| |
| |
| |
| |
| | |
Found via
```
codespell -q 3 -S *.js,*.po,./src/translator*,*.eps,./doc/changelog.doc -L ang,ans,attribs,ba,behaviour,classe,colour,german,iff,initialise,nam,nd,que,russian,statics,te,tim,uint
```
|
| |/ |
|
| |
|
|
|
| |
Create a consistent way to display the state mnemonics of the different scanners (analogous to the fortranscanner.l)
Use an automatic procedure to generate the routine with the translation of the states to a string.
|
| |
|
|
| |
for the derived class (fix)
|
| |
|
|
| |
for the derived class
|
| |
|
|
| |
Signed-off-by: Adrian Negreanu <groleo@gmail.com>
|
| |\
| |
| | |
Class definition with collections
|
| | |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
Class definitions can have collections and these can have strings e.g.:
class Url(namedtuple('Url', url_attrs)):
and this results in:
warning: Detected potential recursive class relation between class conda::_vendor::urllib3::util::url::Url and base class Url!
Strings are now possible and seen as strings.
See also (including example with namedtuble): https://docs.python.org/3/library/collections.html
|
| |/ |
|
| | |
|
| |
|
|
| |
Python #6706
|
| | |
|
| | |
|
| | |
|
| |\
| |
| | |
Namespace with name docstrings_linebreak
|
| | |
| |
| |
| |
| | |
As a regression on pull request #674 in respect to the moving of the markdown handling place the `\_linebreak` command is not translated anymore.
In fact the `\_linebreak` is not necessary at all only the space is required as the `\namespace` command takes just one word as argument.
|
| |/
|
|
| |
Note: especially latexdocvisitor (dead code that should not be dead code).
|
| |
|
|
|
|
| |
Added asterisks in the type field.
The type is temporary stored in a variable as the argument field has not yet been defined for its argument.
|
| | |
|
