JakubAndrysek / MkDoxy

📖 Automatically generates API documentation for your project based on Doxygen comments and code snippets in your markdown files.
https://mkdoxy.kubaandrysek.cz/
MIT License
60 stars 16 forks source link

Watch doxygen #23

Closed JakubAndrysek closed 2 years ago

sourcery-ai[bot] commented 2 years ago

Sourcery Code Quality Report

✅  Merging this PR will increase code quality in the affected files by 0.17%.

Quality metrics Before After Change
Complexity 18.93 😞 17.60 🙂 -1.33 👍
Method Length 39.69 ⭐ 42.64 ⭐ 2.95 👎
Working memory 9.34 🙂 9.31 🙂 -0.03 👍
Quality 64.28% 🙂 64.45% 🙂 0.17% 👍
Other metrics Before After Change
Lines 2601 2312 -289
Changed files Quality Before Quality After Quality Change
doxygen_snippets/doxygen.py 53.40% 🙂 55.61% 🙂 2.21% 👍
doxygen_snippets/doxyrun.py 87.05% ⭐ 75.52% ⭐ -11.53% 👎
doxygen_snippets/finder.py 76.71% ⭐ 76.12% ⭐ -0.59% 👎
doxygen_snippets/generatorAuto.py 83.53% ⭐ 78.78% ⭐ -4.75% 👎
doxygen_snippets/generatorBase.py 69.77% 🙂 65.79% 🙂 -3.98% 👎
doxygen_snippets/generatorSnippets.py 72.49% 🙂 73.14% 🙂 0.65% 👍
doxygen_snippets/markdown.py 93.37% ⭐ 93.51% ⭐ 0.14% 👍
doxygen_snippets/node.py 62.78% 🙂 63.86% 🙂 1.08% 👍
doxygen_snippets/plugin.py 45.73% 😞 39.67% 😞 -6.06% 👎
doxygen_snippets/utils.py 63.67% 🙂 74.35% 🙂 10.68% 👍
doxygen_snippets/xml_parser.py 22.33% ⛔ 25.20% 😞 2.87% 👍

Here are some functions in these files that still need a tune-up:

File Function Complexity Length Working Memory Quality Recommendation
doxygen_snippets/xml_parser.py XmlParser.paras 118 ⛔ 966 ⛔ 28 ⛔ 1.26% ⛔ Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
doxygen_snippets/node.py Node.codeblock 57 ⛔ 356 ⛔ 16 ⛔ 11.55% ⛔ Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
doxygen_snippets/node.py Node._check_for_children 49 ⛔ 459 ⛔ 10 😞 20.49% ⛔ Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
doxygen_snippets/plugin.py DoxygenSnippets.on_files 23 😞 364 ⛔ 15 😞 23.80% ⛔ Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
doxygen_snippets/node.py Node.__init__ 15 🙂 381 ⛔ 17 ⛔ 27.28% 😞 Try splitting into smaller methods. Extract out complex expressions

Legend and Explanation

The emojis denote the absolute quality of the code:

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.


Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!