where is official source code doxygen document, and can I upload the doc to my personal website?

Discussions about the wiki documentation of FreeCAD and its translation.
qingfeng.xia
Posts: 172
Joined: Tue Sep 22, 2015 1:47 pm
Location: Oxford Uk
Contact:

where is official source code doxygen document, and can I upload the doc to my personal website?

Postby qingfeng.xia » Sat Sep 26, 2015 11:16 am

Dear all,

I found the wiki link to a sourceforge.net version 0.12, a bit outdated.

I have a personal website, I use only 1% of my 15G storage. If copyright and license is not a problem, I can generate 0.15 and 0.16dev document to my website. It saves time to build it, I find the class inheritance graph is quite useful to understand the source code.

Definitely, all the copy right belongs to "FreeCAD developer team"

Thanks
Ubuntu LTS 64bit in virtualbox, always work with latest FreeCAD git version
Mainly work on OpenFOAM + Fenics for CFD, FSI
User avatar
yorik
Site Admin
Posts: 11567
Joined: Tue Feb 17, 2009 9:16 pm
Location: São Paulo, Brazil
Contact:

Re: where is official source code doxygen document, and can I upload the doc to my personal website?

Postby yorik » Sat Sep 26, 2015 11:28 pm

Hi,
Thanks for your offer, indeed, we migrated away from sourceforge some time ago, and still didn't transfer everything to the new location. But it's in the plans, we should have that set up soon.
User avatar
sgrogan
Posts: 5428
Joined: Wed Oct 22, 2014 5:02 pm

Re: where is official source code doxygen document, and can I upload the doc to my personal website?

Postby sgrogan » Sun Sep 27, 2015 12:07 am

There is this:
viewtopic.php?t=11700#p94090 or the direct link to the docs here:
http://opencyclingcomputer.eu/FreeCAD/S ... index.html
@yorik, I'd like to help with this if I can. Should I try to install doxygen and build that for the 0.15 release branch to start. I've seen mention of Sphinx for the python stuff, any hints?
User avatar
yorik
Site Admin
Posts: 11567
Joined: Tue Feb 17, 2009 9:16 pm
Location: São Paulo, Brazil
Contact:

Re: where is official source code doxygen document, and can I upload the doc to my personal website?

Postby yorik » Sun Sep 27, 2015 2:06 am

Basically this is what I'd like to do. You help (or anyone else) would be welcome...

1) The sphynx stuff is obsolete. It never did what I wanted it to do (walk through ALL of the python API) and now, doxygen does as well or better... We should simply remove it I think, and concentrate everything on doxygen

2) The doxygen doc already does some good job with python. But it is still pretty confused because it mixes python doc with C++. We should find a clean way to separate them.

3) The python doc is not optimal yet, for example the Draft module (which is where I worked so far) has several pages (one in modules, one in classes, etc) that display different information. They should be gathered/merged somehow...

4) Doxygen docs look nicer when using doxygen-style comments ( http://www.stack.nl/~dimitri/doxygen/ma ... thonblocks ) but of course we want to keep using our python docstrings (so they work in python too). We should see if there isn't something we can do to keep using the docstring and make the doc nicer... Maybe this is just some css to do afterwards...

5) The whole generated doc is almost 2Gb. Which is absurdly huge, it's three times the size of the FreeCAD source itself... There must be something we can do to shrink that...

6) There are still several python parts that are undocumented. We need to identify them, and add the necessary stuff (add a .dox file in the folder, and doxygen-specif comments where needed (see beginning of Draft.py)

7) I'd like to do something like this so it blends nicely with our new homepage: http://coactionos.com/embedded%20design ... Bootstrap/
qingfeng.xia
Posts: 172
Joined: Tue Sep 22, 2015 1:47 pm
Location: Oxford Uk
Contact:

Re: where is official source code doxygen document, and can I upload the doc to my personal website?

Postby qingfeng.xia » Sun Sep 27, 2015 8:12 am

Thanks very much, it seem it is permissible to upload the doxygen generated document to my personal website:

http://iesensor.com/FreeCADDoc/0.16-dev/

I can compile the 0.15 version too.

Sorry, I can not help to deal with doxygen + python.

I am making note during reading the source code, and aimed to make a simple ebook "Module developer's guide to FreeCAD source"
Ubuntu LTS 64bit in virtualbox, always work with latest FreeCAD git version
Mainly work on OpenFOAM + Fenics for CFD, FSI
User avatar
yorik
Site Admin
Posts: 11567
Joined: Tue Feb 17, 2009 9:16 pm
Location: São Paulo, Brazil
Contact:

Re: where is official source code doxygen document, and can I upload the doc to my personal website?

Postby yorik » Sun Sep 27, 2015 4:44 pm

qingfeng.xia wrote:Thanks very much, it seem it is permissible to upload the doxygen generated document to my personal website:
Yes of course! It is always good to have one more place where the doc is available.
qingfeng.xia wrote:I am making note during reading the source code, and aimed to make a simple ebook "Module developer's guide to FreeCAD source"
Oh, that would be VERY useful. If you wish, you can also help with building our wiki... ;) http://www.frecadweb.org/wiki/
User avatar
PrzemoF
Posts: 2654
Joined: Fri Jul 25, 2014 4:52 pm
Contact:

Re: where is official source code doxygen document, and can I upload the doc to my personal website?

Postby PrzemoF » Sun Sep 27, 2015 6:00 pm

Also here: http://opencyclingcomputer.eu/FreeCAD/SourceDocu/html/
It's the cutting edge generated from the master branch.
User avatar
PrzemoF
Posts: 2654
Joined: Fri Jul 25, 2014 4:52 pm
Contact:

Re: where is official source code doxygen document, and can I upload the doc to my personal website?

Postby PrzemoF » Sun Apr 10, 2016 6:21 pm

PrzemoF wrote:Also here: http://opencyclingcomputer.eu/FreeCAD/SourceDocu/html/
It's the cutting edge generated from the master branch.
Updated to 0.16
User avatar
NormandC
Posts: 18534
Joined: Sat Feb 06, 2010 9:52 pm
Location: Québec, Canada

Re: where is official source code doxygen document, and can I upload the doc to my personal website?

Postby NormandC » Sun Apr 10, 2016 7:31 pm

Off topic: do you plan on resuming work on your open cycling computer Przemo? I've taken up cycling 2 years ago and I commute to work by bike in the summer (when the weather allows), I have a simple cycling computer but your Raspberry Pi based computer seems very cool! :)
User avatar
PrzemoF
Posts: 2654
Joined: Fri Jul 25, 2014 4:52 pm
Contact:

Re: where is official source code doxygen document, and can I upload the doc to my personal website?

Postby PrzemoF » Sun Apr 10, 2016 8:59 pm

NormandC wrote:
Off topic: do you plan on resuming work on your open cycling computer Przemo? I've taken up cycling 2 years ago and I commute to work by bike in the summer (when the weather allows), I have a simple cycling computer but your Raspberry Pi based computer seems very cool! :)
We don't have an off-topic section, so I'll reply here.

First of all: thanks! I hope it will be a cool gadget if I can make it real :D
Yes, I will resume the works, but I got stuck with making a proper waterproof case. I don't want to pay ~50 euro for 3D powder printing the case as I don't think I could design it properly in one iteration, so I'd end up paying ~150 euro for 2-3 versions. "Normal" hot ABS 3D printing is not good enough - waterproofing it seems to be impossible. I was considering other options (hard foam + glass fiber/carbon fiber shell, resin cast or even wood + paint coat), but nothing seems to be cheap, easy to replicate for others and be durable enough. I can't use metal to make the case as it would probably be a nice Faraday cage for GPS, bluetooth and wifi.
Anyway if I don't find anything suitable soon I'll have to go the 3D powder printing route.

P.S. I'm quietly hoping for some new raspberry pi model A+, but with wifi + bluetooth LE. That would make some things much easier.