Skip to content

Commit

Permalink
chore(code): fixed some module docs warnings
Browse files Browse the repository at this point in the history
Signed-off-by: Markus Braun <[email protected]>
  • Loading branch information
mb-emag committed Dec 9, 2022
1 parent 8b84b87 commit 7580bbf
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions doxysphinx/html_parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ class RstInlineProcessor:
)

def try_process(self, element: _Element) -> bool:
"""Tries to process an rst inline element into a neutralized format.
"""Try to process an rst inline element into a neutralized format.
:param element: The html element to process
:return: True if the element was processed else False
Expand Down Expand Up @@ -334,7 +334,7 @@ def try_process(self, element: _Element) -> bool:


def _flattened_element_text(element: _Element) -> str:
"""flatten (removes children but keeps the text and html nodes) an element text."""
"""Flatten (removes children but keeps the text and html nodes) an element text."""
text = element.text
if not text:
return ""
Expand Down Expand Up @@ -501,15 +501,13 @@ def _all_supported_elements() -> Set[str]:
return {e for p in DoxygenHtmlParser._processors for e in p.elements}

def _normalize_tree_and_get_used_formats(self, tree) -> Set[str]:
"""
Normalize a doxygen html tree.
"""Normalize a doxygen html tree.
Searches for pre and code tags, re-formats them and creates different <snippet-*>-tags out of it.
Will also put a newline behind the closing tag because it's necessary to have lines that can be clearly
assigned to either html-content or snippet content (and in the un-normalized source html we've got them mixed
at the closing tag).
"""

used_snipped_formats = set()

# prefetch element candidates.
Expand Down

0 comments on commit 7580bbf

Please sign in to comment.