You are not logged in. Please login or register.
QElectroTech → Code → add documentation of functions patch files
Merged, thanks Simon.
scorpio810
can I try to make the other documentation of the functions in Qdoc?
https://doc.qt.io/qt-5/01-qdoc-manual.html
or is this unnecessary?
Is like Doxygen?
https://download.qelectrotech.org/qet/d … index.html
https://git.tuxfamily.org/qet/qet.git/tree/Doxyfile
Why not.
Is like Doxygen?
https://download.qelectrotech.org/qet/d … index.htmlhttps://git.tuxfamily.org/qet/qet.git/tree/Doxyfile
Why not.
fantastic this seems to be a source of information I will look at this further tomorrow.
https://www.sinax.be/blog/software-deve … eator.html
https://github.com/fpoussin/qtcreator-doxygen
Thanks Simon.
-Mod doc's
-Fix-indentation-code
-Wrap-code
patch_15.zip 18.2 kb, 241 downloads since 2020-07-15
Thanks Simon.
For now I leave the french documentation and add the english text
But what is the intention in the future?
Everything to english or bilingual( eg: english and french).
I ask this because the documentation needs to be maintained.
I also note that the code contains two(or more) styles, likewise for the documentation
styles:(there is both good code and less good code)
Agree this is criticism but I am less critical in the meantime, the code is not bad.
There is simply still a lot of room for improvement.
The intention in future is translate french documentation to english, but is a pain to make it.
Even is more easy for me and Joshua to understand code with french documentation...:p
But for new not french contributor isn't easy to understand this code..
I'm fixing a lot of indent code.
More time developer comment is good for understanding code, please keep it.
FYI we are not a professional developer but a maintenance technician in the industry.
https://download.qelectrotech.org/qet/s … roject.txt
ok
I leave French in, the removal can be tackled for version 1.0. for example.
https://www.sinax.be/blog/software-deve … eator.html
https://github.com/fpoussin/qtcreator-doxygen
I got it working thanks
Screenshot_20200715_213746.png 938.67 kb, 108 downloads since 2020-07-15
Great! ;-)
I now see better how it looks in doxygen
first test file/class
0001-Mod-doc-for-better-readability-doxygen.patch 7.93 kb, 228 downloads since 2020-07-15
Update Doxyfile:
Please change STRIP_FROM_PATH to your source location and maybe QHG_LOCATION path depending on your distrib.
run
doxygen DoxyfileNow add QElectroTech.qch in qtcreator ->tools-> help like this to your doc folder "QHP_VIRTUAL_FOLDER "
No need to compile the plugin or qtcreator, we only need a recent qtcreator binary.
Enjoy !
I now see better how it looks in doxygen
first test file/class
Merged, thanks Simon.
I now see better how it looks in doxygen
first test file/class
I will test tomorrow:
https://www.doxygen.nl/manual/commands.html#cmdtilde
Example:
/*! \~english This is English \~dutch Dit is Nederlands \~german Dies ist
Deutsch. \~ output for all languages.
*/
Multilingual comment in code are great for all want to contribute.
These improve my compile time.. :-)
23:08:40: Le processus "/usr/bin/make" s'est terminé normalement.
23:08:40: Elapsed time: 00:18.
make[1] : on quitte le répertoire « /home/laurent/qet_git/build »
real 0m17,314s
user 11m28,038s
sys 1m8,455s
qtcreator_doxyfile.png 1.41 mb, 129 downloads since 2020-07-15
These improve my compile time.. :-)
23:08:40: Le processus "/usr/bin/make" s'est terminé normalement.
23:08:40: Elapsed time: 00:18.make[1] : on quitte le répertoire « /home/laurent/qet_git/build »
real 0m17,314s
user 11m28,038s
sys 1m8,455s
my machine, at least I can still drink my coffee.
The process "/usr/bin/make" exited normally.
Elapsed time: 01:06.make -j16
Ryzen?
QElectroTech → Code → add documentation of functions patch files
Powered by PunBB, supported by Informer Technologies, Inc.
Generated in 0.025 seconds (28% PHP - 72% DB) with 10 queries