1 (edited by De-Backer 2020-07-12 22:58:47)

Topic: add documentation of functions patch files

add documentation of some functions, removed Q_UNUSED for used value's and a fix white space

Post's attachments

Attachment icon patch.zip 5.6 kb, 253 downloads since 2020-07-12 

Re: add documentation of functions patch files

Merged, thanks Simon.

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."

Re: add documentation of functions patch files

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?

Re: add documentation of functions patch files

Is like Doxygen?
https://download.qelectrotech.org/qet/d … index.html

https://git.tuxfamily.org/qet/qet.git/tree/Doxyfile

Why not.

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."

Re: add documentation of functions patch files

fantastic this seems to be a source of information I will look at this further tomorrow.

Re: add documentation of functions patch files

https://www.sinax.be/blog/software-deve … eator.html
https://github.com/fpoussin/qtcreator-doxygen

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."

Re: add documentation of functions patch files

-doxygen is fine.
-Mod doc's
-todo: will add Commit information in contrib.MD (source: github)

Post's attachments

Attachment icon patch.zip 4.73 kb, 249 downloads since 2020-07-14 

Re: add documentation of functions patch files

Thanks Simon.

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."

Re: add documentation of functions patch files

-Mod doc's
-Fix-indentation-code
-Wrap-code

Post's attachments

Attachment icon patch_15.zip 18.2 kb, 242 downloads since 2020-07-15 

Re: add documentation of functions patch files

Thanks Simon.

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."

Re: add documentation of functions patch files

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.

Re: add documentation of functions patch files

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..

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."

Re: add documentation of functions patch files

I'm fixing a lot of indent code.

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."

Re: add documentation of functions patch files

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

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."

Re: add documentation of functions patch files

ok
I leave French in, the removal can be tackled for version 1.0. for example.

Re: add documentation of functions patch files

I got it working thanks

Post's attachments

Attachment icon Screenshot_20200715_213746.png 938.67 kb, 108 downloads since 2020-07-15 

Re: add documentation of functions patch files

Great! ;-)

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."

Re: add documentation of functions patch files

I now see better how it looks in doxygen

first test file/class

Post's attachments

Attachment icon 0001-Mod-doc-for-better-readability-doxygen.patch 7.93 kb, 229 downloads since 2020-07-15 

Re: add documentation of functions patch files

Update Doxyfile:
Please change STRIP_FROM_PATH to your source location and maybe QHG_LOCATION  path depending on your distrib.

run

doxygen Doxyfile

Now add QElectroTech.qch in qtcreator ->tools-> help like this to your doc folder "QHP_VIRTUAL_FOLDER "
https://www.sinax.be/images/doxygen-qt-creator/qtcreator-settings.png

No need to compile the plugin or qtcreator, we only need a recent qtcreator binary.
Enjoy !

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."

Re: add documentation of functions patch files

De-Backer wrote:

I now see better how it looks in doxygen

first test file/class

Merged, thanks Simon.

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."

Re: add documentation of functions patch files

De-Backer wrote:

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.
 */

Re: add documentation of functions patch files

Multilingual comment in code are great for all want to contribute.

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."

Re: add documentation of functions patch files

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

Post's attachments

Attachment icon qtcreator_doxyfile.png 1.41 mb, 130 downloads since 2020-07-15 

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."

24 (edited by De-Backer 2020-07-16 05:27:57)

Re: add documentation of functions patch files

scorpio810 wrote:

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

Re: add documentation of functions patch files

Ryzen?

"Le jour où tu découvres le Libre, tu sais que tu ne pourras jamais plus revenir en arrière..."