Mysidia Adoptables Support Forum  

Home Community Mys-Script Creative Off-Topic
Go Back   Mysidia Adoptables Support Forum > Mysidia Adoptables > Suggestions and Feature Requests

Notices

 
 
Thread Tools Display Modes
Prev Previous Post   Next Post Next
  #11  
Old 02-04-2014, 08:31 AM
IntoRain's Avatar
IntoRain IntoRain is offline
Moderator
 
Join Date: Jul 2013
Location: Portugal
Posts: 461
Gender: Female
Credits: 19,255
IntoRain is on a distinguished road
Default

Can I suggest doxygen-style comments for the classes and functions? Doxygen automatically generates a wiki thing (.html) with information on all classes and functions from just comments, making it easier in my opinion for us to search for stuff. I know it kinda sucks to comment everything, but since you will be changing the code a lot and since some of the older functions and core classes are already commented, I thought I'd suggest doxygen-style comments: http://www.doxygen.nl/docblocks.html

The generated .html pages look awesome:

http://i.imgur.com/xwg2V9c.png (example of a function description (detailed) - it has the call graph and the caller graph!)

http://i.imgur.com/O8nIDdC.png (example of a class list, it shows undetailed member functions with the details at the end of the page - it has a search function! it also shows class hierarchy, files, etc!)
__________________


asp.net stole my soul.
Reply With Quote
 

Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off

Forum Jump

Similar Threads
Thread Thread Starter Forum Replies Last Post
The Official ACP Overhaul Thread for Mys v1.4.0 Hall of Famer Suggestions and Feature Requests 24 05-14-2013 03:23 PM
The official itemshop thread Hall of Famer Suggestions and Feature Requests 12 08-26-2011 06:43 AM
The official Zune/Ipod thread.. But mainly Zune because I'm biased. shiann Other Chat 4 03-20-2011 07:19 PM
The Official Mys v1.2.0 Thread[Beta available in Premium Members Forum now!] Hall of Famer Mysidia Adoptables Official Announcement 86 03-12-2011 04:53 AM
Suggestions Thread: RoconzaArt Adoptables Buzz 3 01-18-2011 06:55 PM


All times are GMT -5. The time now is 04:39 AM.

Currently Active Users: 448 (0 members and 448 guests)
Threads: 4,080, Posts: 32,024, Members: 2,016
Welcome to our newest members, jolob.
BETA





What's New?

What's Hot?

What's Popular?


Powered by vBulletin® Version 3.8.11
Copyright ©2000 - 2024, vBulletin Solutions Inc.
vBCommerce I v2.0.0 Gold ©2010, PixelFX Studios
vBCredits I v2.0.0 Gold ©2010, PixelFX Studios
Emoticons by darkmoon3636