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

DeprecationWarning: Testing an element's truth value #100

Closed QINZHAOYU closed 2 weeks ago

QINZHAOYU commented 2 months ago

Thank you very much for the tool, perfect solution to my need to generate documentation for C++ projects!

While i upgrade python from 3.9 to 3.12.2, with mkdoxy 1.2.0, there is a warning appeared, as below:

INFO - Building documentation... INFO - Cleaning site directory INFO - Start plugin MkDoxy INFO - -> Start project 'models' INFO - -> generating Doxygen files INFO - DeprecationWarning: Testing an element's truth value will raise an exception in future versions. Use specific 'len(elem)' or 'elem is not None' test instead. File "D:\miniconda3\envs\oasis\Lib\site-packages\mkdoxy\node.py", line 736, in brief return self._brief.md() File "D:\miniconda3\envs\oasis\Lib\site-packages\mkdoxy\property.py", line 38, in md if not briefdescription:

I'm not sure if it's the python version that causes it, just as a feedback.

JakubAndrysek commented 2 months ago

Thank you for finding the warning, I will look at it.