codeape Posted September 10, 2014 Share Posted September 10, 2014 Hello On top of my doc list is documentation in the header files. Most IDE:s (including Visual C++ Express, Code::Blocks and Xcode) can contextualy display doc strings of methods and classes being used (for example when you do code completion). So, by using for example doxygen formated comments in the code that explains a little about a method would increase the coding speed and make less bug reports. We will get less bug reports on missing doc because Josh could kindly write "not officially supported" for a method or class but also add some doc about it anyway ... to be very kind. This of course takes less time and could be pushed in the future.s However, second on my list is to update the command reference with appending all not official method in their respective classes/struct and the text "not officially supported". Because ... if you have a header file you will surely look in it and wonder ... why is this method not in the doc? Head over to the bug forum etc. etc. This is an ok solution for now and can not take up to much time of Josh. 1 Quote Link to comment Share on other sites More sharing options...
Guppy Posted September 10, 2014 Share Posted September 10, 2014 *cough* doxygen *cough* I've even been tempted to add the comments my self but as they will get overriden by updates.. 1 Quote System: Linux Mint 17 ( = Ubuntu 14.04 with cinnamon desktop ) Ubuntu 14.04, AMD HD 6850, i5 2500k Link to comment Share on other sites More sharing options...
CrazyM Posted September 10, 2014 Share Posted September 10, 2014 It would certainly make it easier than my current header file strategy of "I wonder what this does". Quote CrazyMinnowStudio.com Youtube, Twitter, Facebook, G+ Link to comment Share on other sites More sharing options...
Recommended Posts
Join the conversation
You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.