Mysidia Adoptables Support Forum  

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

Notices

 
 
Thread Tools Display Modes
Prev Previous Post   Next Post Next
  #11  
Old 01-16-2015, 12:38 PM
IntoRain's Avatar
IntoRain IntoRain is offline
Moderator
 
Join Date: Jul 2013
Location: Portugal
Posts: 461
Gender: Female
Credits: 22,923
IntoRain is on a distinguished road
Default

Basically you just need to comment the functions and classes with the appropriate comment blocks and it generates a wiki with call graphs and cross references and everything.
Quoting a post I made previously about this:

Quote:
Originally Posted by IntoRain View Post
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!)
(please ignore the fact I used both C-style and Java-style code standards for the function names lol it's messy I know)

You can customize the wiki colors and structure as well, I just didn't lose much time with it.

I say yes to creating a wiki for user guides like Kyttias' though.
__________________


asp.net stole my soul.
Reply With Quote
 


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
Looking for someone to help me build an alert system Infernette Staff Central 4 07-02-2014 05:23 PM
Lionisa - Build up your lion collection! Aasixx Adoptables Buzz 1 08-07-2012 05:10 PM
-Using Scratch to Build A Town- Poppy Tutorials and Tips 3 03-28-2012 07:02 PM


All times are GMT -5. The time now is 10:38 AM.

Currently Active Users: 3476 (0 members and 3476 guests)
Threads: 4,081, Posts: 32,032, 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 - 2025, vBulletin Solutions Inc.
vBCommerce I v2.0.0 Gold ©2010, PixelFX Studios
vBCredits I v2.0.0 Gold ©2010, PixelFX Studios
Emoticons by darkmoon3636