We should build a wiki

[IntoRain]

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:

Originally Posted by IntoRain

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.

[MikiHeart]

Thank you for explaining IntoRain

HoF: Thank you. I understand completely. Are database fields staying the same so that we can upgrade at least the base of our sites? (I know we'll have to rewrite mods and stuff)

[Hall of Famer]

Well the database fields are completely different, you can have a look at the screenshot I took from phpmyadmin for Mys v1.4.0 dev for some insights. Note there will be even more tables to store some settings for certain features, although these can also appear as flat files in .xml format:



However, this does not mean upgrading database will not be possible. There will be mapping for old Mysidia database tables/fields to new Mysidia database tables/fields. It can be complex, but its doable and easily automated. I will release a beta version without upgrader at first prior to the official stable release, during this two weeks beta testing phase I will try to design an upgrader for database.

[Glow]

The next version is really exciting! <3

And also, will there be a wiki implemented then?

[Hall of Famer]

Well you can build a wiki if you want to, for Mys v1.3.x it can be very useful. For Mys v1.4.x though, the script will come with rich documentation for each functionality, so there will be little need for full-fledged wiki pages.

[MikiHeart]

Oh okay.

it looks extremely feature rich. I like that. Including giving the users the ability to block people. Which I think is a very good idea.

I may instead use my time to practice coding with v1.3.x, so that when v1.4.x comes out, my knowledge will have increased and then build off of that script.

Because just by looking at the database I feel that v1.3.x will be shadowed by v1.4.x

[Kyttias]

Indeed! I'm getting my concepts down in 1.3.x with focus on design over functionality. I feel a lot of it will be transferable - but much of it will have to be done manually.

Transferring users and pets however? Might be nigh impossible.

[Glow]

It is possible to like save all your modified codes into a file, then reinstall the newest version of Mysidia before updating all your modified codes maybe? XD And then adding back content, that is, if your site has not open to public...

[MikiHeart]

Glow: Everything custom coded would need to be recoded to work with the new version.

[Glow]

Oh sorry, I'm kind of not really totally understanding whats going on haha thanks XD