FreeCAD coding/documentation standards?

Discussions about the wiki documentation of FreeCAD and its translation.
User avatar
Kunda1
Posts: 624
Joined: Thu Jan 05, 2017 9:03 pm

FreeCAD coding/documentation standards?

Postby Kunda1 » Mon Feb 06, 2017 10:29 am

Is there a place where these are stated?
For coding:
uniform coding style for c++
uniform coding style for python
indentation, parenthesis, dos and don'ts
comment styling

I see https://www.freecadweb.org/wiki/index.p ... ource_code but it's a summary not specifics
https://www.freecadweb.org/wiki/index.p ... ui_Command has some info but very limited to specific subject

For documentation:
How to write doxygen comments for FreeCAD? (ref: http://www.iesensor.com/FreeCADDoc/0.16-dev/index.html or https://www.freecadweb.org/api/)
How to comment FC code?

EDIT:
FYI https://www.freecadweb.org/api/ is broken

EDIT 2:
I did find @qingfengxia effort at: https://github.com/qingfengxia/FreeCAD_Mod_Dev_Guide
Jee-Bee
Posts: 615
Joined: Tue Jun 16, 2015 10:32 am
Location: Netherlands

Re: FreeCAD coding/documentation standards?

Postby Jee-Bee » Mon Feb 06, 2017 10:38 am

User avatar
PrzemoF
Posts: 1706
Joined: Fri Jul 25, 2014 4:52 pm
Contact:

Re: FreeCAD coding/documentation standards?

Postby PrzemoF » Mon Feb 06, 2017 10:40 am

For python in FEM: https://forum.freecadweb.org/viewtopic.php?f=18&t=12833

There were suggestions to use it for the rest of FreeCAD, but I don't know if it happened.
User avatar
kkremitzki
Posts: 321
Joined: Thu Mar 03, 2016 9:52 pm
Location: Texas

Re: FreeCAD coding/documentation standards?

Postby kkremitzki » Mon Feb 06, 2017 11:20 am

Kunda1 wrote:EDIT:
FYI https://www.freecadweb.org/api/ is broken


Fixed via FTP and in repo via PR 504. There's still an error on both HTTP and HTTPS though, what is this "dynsections.js" in
https://github.com/kkremitzki/FreeCAD/b ... r.html#L17
?
It isn't present on the server, obviously, and it isn't present in a "make DevDoc" build folder...

Edit: Bleh, only index.html is fixed, new docs will need to be built.
User avatar
Kunda1
Posts: 624
Joined: Thu Jan 05, 2017 9:03 pm

Re: FreeCAD coding/documentation standards?

Postby Kunda1 » Mon Feb 06, 2017 1:15 pm

kkremitzki wrote:
Kunda1 wrote:EDIT:
FYI https://www.freecadweb.org/api/ is broken


Fixed via FTP and in repo via PR 504. There's still an error on both HTTP and HTTPS though, what is this "dynsections.js" in
https://github.com/kkremitzki/FreeCAD/b ... r.html#L17
?
It isn't present on the server, obviously, and it isn't present in a "make DevDoc" build folder...

Edit: Bleh, only index.html is fixed, new docs will need to be built.


Thanks @kkremitzki !
yorik wrote:summoning @yorik to rebuild api docs

Thanks!
User avatar
kkremitzki
Posts: 321
Joined: Thu Mar 03, 2016 9:52 pm
Location: Texas

Re: FreeCAD coding/documentation standards?

Postby kkremitzki » Mon Feb 06, 2017 3:14 pm

Kunda1 wrote:
summoning @yorik to rebuild api docs

Thanks!

I actually have FTP superpowers now so I built the API web docs myself and I'm pushing them as we speak 8-)
User avatar
Kunda1
Posts: 624
Joined: Thu Jan 05, 2017 9:03 pm

Re: FreeCAD coding/documentation standards?

Postby Kunda1 » Mon Feb 06, 2017 5:05 pm

PrzemoF wrote:For python in FEM: https://forum.freecadweb.org/viewtopic.php?f=18&t=12833

There were suggestions to use it for the rest of FreeCAD, but I don't know if it happened.

@PrzemoF Great. Should I continue the conversation in the FEM sub-forum or continue it here?

kkremitzki wrote:I actually have FTP superpowers now so I built the API web docs myself and I'm pushing them as we speak 8-)

Awesome...thanks for being so johnny on the spot :D
User avatar
yorik
Site Admin
Posts: 8556
Joined: Tue Feb 17, 2009 9:16 pm
Location: São Paulo, Brazil
Contact:

Re: FreeCAD coding/documentation standards?

Postby yorik » Tue Feb 07, 2017 12:26 pm

kkremitzki wrote:I'm pushing them as we speak 8-)

Thanks!