Mysidia Adoptables Support Forum  

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

Reply
 
Thread Tools Display Modes
  #51  
Old 02-04-2014, 09:31 AM
IntoRain's Avatar
IntoRain IntoRain is offline
Moderator
 
Join Date: Jul 2013
Location: Portugal
Posts: 461
Gender: Female
Credits: 14,413
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
  #52  
Old 02-04-2014, 03:06 PM
Hall of Famer's Avatar
Hall of Famer Hall of Famer is offline
Administrator, Lead Coder
 
Join Date: Dec 2008
Location: Somerville
Posts: 4,388
Gender: Male
Credits: 126,247
Hall of Famer is on a distinguished road
Default

Thats a good suggestion IntoRain. And yes I've been working on the documentation system as well, it will be similar to JavaDoc style. By the time the new version is about to be released I will generate the documentation so you all can read and see how to use the classes. Some complex class methods may even get their own examples on how to use effectively.
__________________


Mysidia Adoptables, a free and ever-improving script for aspiring adoptables/pets site.
Reply With Quote
  #53  
Old 02-04-2014, 04:28 PM
Kyttias's Avatar
Kyttias Kyttias is offline
Premium Member
 
Join Date: Jan 2014
Posts: 840
Gender: Unknown/Other
Credits: 35,661
Kyttias is on a distinguished road
Default

Quote:
Originally Posted by Hall of Famer View Post
Thats a good suggestion IntoRain. And yes I've been working on the documentation system as well, it will be similar to JavaDoc style. By the time the new version is about to be released I will generate the documentation so you all can read and see how to use the classes. Some complex class methods may even get their own examples on how to use effectively.
Can't wait!

(Is there a projected release data for v1.4? We're a few months out still, but just curious. )
Reply With Quote
  #54  
Old 02-04-2014, 05:20 PM
Hall of Famer's Avatar
Hall of Famer Hall of Famer is offline
Administrator, Lead Coder
 
Join Date: Dec 2008
Location: Somerville
Posts: 4,388
Gender: Male
Credits: 126,247
Hall of Famer is on a distinguished road
Default

I do not have a projected release date yet, but the time period should be around summer. I'm currently working on the model/domain layer of the application, aka new database and model design and object-relational mapping. Perhaps I should post a thread indicating the progress of the new version and update it whenever something happens?
__________________


Mysidia Adoptables, a free and ever-improving script for aspiring adoptables/pets site.
Reply With Quote
  #55  
Old 02-04-2014, 06:28 PM
squiggler's Avatar
squiggler squiggler is offline
Squiggling since 1995
 
Join Date: Jul 2013
Posts: 185
Gender: Unknown/Other
Credits: 4,172
squiggler is on a distinguished road
Default

Quote:
Originally Posted by Hall of Famer View Post
I do not have a projected release date yet, but the time period should be around summer. I'm currently working on the model/domain layer of the application, aka new database and model design and object-relational mapping. Perhaps I should post a thread indicating the progress of the new version and update it whenever something happens?
That would be perfect, thanks!
__________________
Avatar courtesy of Doll Divine.
Reply With Quote
  #56  
Old 02-04-2014, 06:40 PM
IntoRain's Avatar
IntoRain IntoRain is offline
Moderator
 
Join Date: Jul 2013
Location: Portugal
Posts: 461
Gender: Female
Credits: 14,413
IntoRain is on a distinguished road
Default

Quote:
Originally Posted by Hall of Famer View Post
Thats a good suggestion IntoRain. And yes I've been working on the documentation system as well, it will be similar to JavaDoc style. By the time the new version is about to be released I will generate the documentation so you all can read and see how to use the classes. Some complex class methods may even get their own examples on how to use effectively.
Thank you so much! That sounds pretty neat!
__________________


asp.net stole my soul.
Reply With Quote
  #57  
Old 02-10-2014, 08:43 AM
Hall of Famer's Avatar
Hall of Famer Hall of Famer is offline
Administrator, Lead Coder
 
Join Date: Dec 2008
Location: Somerville
Posts: 4,388
Gender: Male
Credits: 126,247
Hall of Famer is on a distinguished road
Default

You are very welcome. For now I can update you guys/gals on some information on Mys v1.4.0, its not anything like an official update but should give you some clues on what will become of the project.

-- It will support the following database systems: MySQL, PostgreSQL, Sqlite3, OCI8 and MSSQL, though MySQL is highly recommended.
-- It will have around 70-80+ database tables(60+ data tables and 10-20 settings tables), thus doubling the number from Mys v1.3.4.
-- It will have an improved friend system, users can set privacy options to make certain part of their profile or other properties to be viewed only by friends.
-- It will have an ignore system, similar to the friend-system. If you get tired of some users pestering you with messages or trade offers, it will come in handy.
-- It will feature a moderation system in which you can selectively approve/disapprove actions by certain users.
-- It will come with a pseudo-cronjob system that runs scheduled tasks. You can create cron job scripts and link them in ACP to enable scheduled events.
-- It will feature an improved plugin/hook system, making true addon scripts possible rather than mods that require editing core script files.
-- It will offer internationalization support, although only English is available for the official package.


If you find any of the above updates interesting or confusing, please let me know and I dont mind explaining them in details. I'm currently working on the model layer(aka the domain/business and infrastructure layers) of the new script, things are shaping up nicely for now.
__________________


Mysidia Adoptables, a free and ever-improving script for aspiring adoptables/pets site.
Reply With Quote
  #58  
Old 02-10-2014, 04:57 PM
squiggler's Avatar
squiggler squiggler is offline
Squiggling since 1995
 
Join Date: Jul 2013
Posts: 185
Gender: Unknown/Other
Credits: 4,172
squiggler is on a distinguished road
Default

Thanks for the update! How would 'true addon scripts' be created? I'm worried there's gonna be a massive learning curve.
__________________
Avatar courtesy of Doll Divine.
Reply With Quote
  #59  
Old 02-10-2014, 06:20 PM
Hall of Famer's Avatar
Hall of Famer Hall of Famer is offline
Administrator, Lead Coder
 
Join Date: Dec 2008
Location: Somerville
Posts: 4,388
Gender: Male
Credits: 126,247
Hall of Famer is on a distinguished road
Default

A true addon script is a hook/plugin event like script that does not require modification of core script files. This way its very easy to install, all you have to do is to upload the plugin files and install it through ACP(you can manage all plugins/mods through ACP with Mys v1.4.0). It will make lives easier for non-coders, and moreover the plugin is most likely to be effective even after you upgrade to a newer version of the script.

The way it works is that the script keeps track of a list of plugins at a certain location, they are saved as collection of event-like objects(or callback objects) that are executed before or after a certain point in program flow. One example of such 'plugin-point' is before/after loading data from database. A plugin would possibly modify the SQL query so if you add a new column to a database table, this column will be loaded and later saved properly. Without a plugin/hook system, you have to edit the query in the core script file, and this change will not last once you upgrade your site.

It should have a learning curve for those of you not familiar with OOP and how design patterns like observer/event works, but it should not be a massive learning curve. I will provide guidelines for creating plugins once the system is complete, so it will not give you too much headache.
__________________


Mysidia Adoptables, a free and ever-improving script for aspiring adoptables/pets site.
Reply With Quote
  #60  
Old 02-10-2014, 11:56 PM
squiggler's Avatar
squiggler squiggler is offline
Squiggling since 1995
 
Join Date: Jul 2013
Posts: 185
Gender: Unknown/Other
Credits: 4,172
squiggler is on a distinguished road
Default

That's wonderful! I think this would be amazing. If you feel like explaining it now (you don't have to!)...would it be like taking current mods and copy-pasting the code into the new format? How much do you think we'd need to modify the mods?
__________________
Avatar courtesy of Doll Divine.
Reply With Quote
Reply

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 05:53 AM
Suggestions Thread: RoconzaArt Adoptables Buzz 3 01-18-2011 07:55 PM


All times are GMT -5. The time now is 09:18 PM.

Currently Active Users: 211 (1 members and 210 guests)
Threads: 3,943, Posts: 31,406, Members: 15,530
Welcome to our newest members, ancrsbys01.
BER





What's New?

What's Hot?

What's Popular?


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