Search found 81 matches

by David_D
Wed Apr 01, 2020 3:35 am
Forum: Draft, Arch & BIM
Topic: This is now a thread about documentation
Replies: 35
Views: 7347

Re: Why are class names prefixed with an underscore?

Most valuable player? Minimum viable product. Dumb startup industry corporate speak. I just meant I'll wait until I've ironed out the very obvious problems, and people can look at a large enough portion of it, that they can appreciate what it's supposed to look like, if expanded further. Your inden...
by David_D
Wed Apr 01, 2020 1:40 am
Forum: Draft, Arch & BIM
Topic: This is now a thread about documentation
Replies: 35
Views: 7347

Re: Why are class names prefixed with an underscore?

What about a diagram produced with GraphViz? Doxygen creates a diagram of the relationship between the classes. It uses the "dot" program which is included with GraphViz. Well, Doxygen is providing all the XML it needs so it should work. Worst case scenario is we use the graphvis python b...
by David_D
Sun Mar 29, 2020 10:38 pm
Forum: Draft, Arch & BIM
Topic: This is now a thread about documentation
Replies: 35
Views: 7347

Re: Why are class names prefixed with an underscore?

About C++, it's not only about documenting a single class or function, but rather automatically generating the relationships between them and creating the diagrams that show the relationship between the classes. That is very helpful when using Doxygen. Here's an example I just generated from FEM: h...
by David_D
Sun Mar 29, 2020 10:33 pm
Forum: Draft, Arch & BIM
Topic: This is now a thread about documentation
Replies: 35
Views: 7347

Re: Why are class names prefixed with an underscore?

About C++, it's not only about documenting a single class or function, but rather automatically generating the relationships between them and creating the diagrams that show the relationship between the classes. That is very helpful when using Doxygen. I followed up on this, and yes, sphinx will re...
by David_D
Sun Mar 29, 2020 7:53 am
Forum: Draft, Arch & BIM
Topic: This is now a thread about documentation
Replies: 35
Views: 7347

Re: Why are class names prefixed with an underscore?

About C++, it's not only about documenting a single class or function, but rather automatically generating the relationships between them and creating the diagrams that show the relationship between the classes. That is very helpful when using Doxygen. I see. The system should be able to see links ...
by David_D
Sun Mar 29, 2020 5:20 am
Forum: Draft, Arch & BIM
Topic: This is now a thread about documentation
Replies: 35
Views: 7347

Re: Why are class names prefixed with an underscore?

Since we have never truly explored Sphinx, I suggest looking into this more. A long time ago the developers did create some tentative documents, but the efforts were not pursued further. You can see the few files tested in src/Doc/sphinx. Ok, I'm pretty certain that sphinx is the way to go. I've pr...
by David_D
Fri Mar 27, 2020 8:39 pm
Forum: Draft, Arch & BIM
Topic: This is now a thread about documentation
Replies: 35
Views: 7347

Re: Why are class names prefixed with an underscore?

Since we have never truly explored Sphinx, I suggest looking into this more. A long time ago the developers did create some tentative documents, but the efforts were not pursued further. You can see the few files tested in src/Doc/sphinx. Alrighty, I'll see if I can produce something that works bet...
by David_D
Fri Mar 27, 2020 5:36 am
Forum: Draft, Arch & BIM
Topic: This is now a thread about documentation
Replies: 35
Views: 7347

Re: Why are class names prefixed with an underscore?

And also, I think a task that should receive priority is investigating a way to handle both C++ and Python in the best way possible to create good documentation. Since FreeCAD is a combination of C++ code with Python, it's actually a bit hard to manage both languages in a simple way. I've found two...
by David_D
Fri Mar 27, 2020 2:43 am
Forum: Draft, Arch & BIM
Topic: This is now a thread about documentation
Replies: 35
Views: 7347

Re: Why are class names prefixed with an underscore?

vocx wrote: Fri Mar 27, 2020 2:03 am
That is quite the pickle. I'll look into the unit tests. I've also noticed a few other strange things about how the documentation is generated so this may be an appropriate time to fix several things.
by David_D
Fri Mar 27, 2020 1:33 am
Forum: Draft, Arch & BIM
Topic: This is now a thread about documentation
Replies: 35
Views: 7347

This is now a thread about documentation

Hey, I'm making an attempt to expand Arch's doxygen documentation, and I noticed that all of the class names are prefixed with an underscore. This will result in none of the commands having documentation generated for them, which is a major gap in the documentation. Underscore prefixed variables/cla...