|
Josh @ Dreamland
|
|
Reply #1 Posted on: May 20, 2010, 02:45:24 pm |
|
|
Prince of all Goldfish
Location: Pittsburgh, PA, USA Joined: Feb 2008
Posts: 2950
|
Those are all just broken after various switches between R3 and 4. R3 supported everything you've named off; I'm waiting for a "good opportunity" to install the new instance system for some of those.
|
|
|
Logged
|
"That is the single most cryptic piece of code I have ever seen." -Master PobbleWobble "I disapprove of what you say, but I will defend to the death your right to say it." -Evelyn Beatrice Hall, Friends of Voltaire
|
|
|
|
MahFreenAmeh
|
|
Reply #3 Posted on: May 21, 2010, 11:35:23 am |
|
|
sysadmin
"Web Team" Location: Austin, TX Joined: Apr 2008
Posts: 13
|
You probably also want a centralized bug tracker. The forums won't do it as ENIGMA grows larger.
a2h is in the process of working one of those out. as per the centralized documentation service, i'm busy working out the kinks and ideas for making one. seems like it would be pretty simple, just have to get the design paradigm down right.
|
|
|
Logged
|
sys(tem)admin(istrator) [java,c++,c,javascript,html,css,php,perl,ruby,python,sql] if you've got ideas, let me hear them.
|
|
|
Josh @ Dreamland
|
|
Reply #4 Posted on: May 21, 2010, 03:22:45 pm |
|
|
Prince of all Goldfish
Location: Pittsburgh, PA, USA Joined: Feb 2008
Posts: 2950
|
And yes, I seemed to be avoiding the real problem here and that is a blatant lack of central docs. I'm torn between the love of my life, SVG, and a format that most people can actually work with. Even printing to PDF doesn't really help. Would you care to propose an easily navigable and at least remotely eye-pleasing format? Especially if the program is even moderately pleasant to work with.
|
|
|
Logged
|
"That is the single most cryptic piece of code I have ever seen." -Master PobbleWobble "I disapprove of what you say, but I will defend to the death your right to say it." -Evelyn Beatrice Hall, Friends of Voltaire
|
|
|
|
Josh @ Dreamland
|
|
Reply #6 Posted on: May 21, 2010, 04:17:50 pm |
|
|
Prince of all Goldfish
Location: Pittsburgh, PA, USA Joined: Feb 2008
Posts: 2950
|
Heh, fuck that.
|
|
|
Logged
|
"That is the single most cryptic piece of code I have ever seen." -Master PobbleWobble "I disapprove of what you say, but I will defend to the death your right to say it." -Evelyn Beatrice Hall, Friends of Voltaire
|
|
|
|
|
Josh @ Dreamland
|
|
Reply #9 Posted on: May 21, 2010, 06:22:32 pm |
|
|
Prince of all Goldfish
Location: Pittsburgh, PA, USA Joined: Feb 2008
Posts: 2950
|
Doxygen is a sad excuse for what could otherwise be a navigable system. I don't want to put too much effort into this, but I less want to put too little. Doxygen made developing for Pidgin my nightmare. I would never wish that on anyone.
|
|
|
Logged
|
"That is the single most cryptic piece of code I have ever seen." -Master PobbleWobble "I disapprove of what you say, but I will defend to the death your right to say it." -Evelyn Beatrice Hall, Friends of Voltaire
|
|
|
|
|
|
Josh @ Dreamland
|
|
Reply #13 Posted on: May 22, 2010, 12:05:55 pm |
|
|
Prince of all Goldfish
Location: Pittsburgh, PA, USA Joined: Feb 2008
Posts: 2950
|
Ah, indeed... These SFML docs are very nice. I had to question whether Doxygen had actually produced them, in fact. They've well-structured the mess of methods that need documented from each class... very easy to navigate. I'd really like to use this, in fact, but it introduces a few issues we'll need to handle...
1) We need a way to document the functions ENIGMA puts at the users disposal in a method with which LGM can interface. 2) Although these are very detailed on a per-function basis, I don't see where they've outlined the overall structure of the project (probably because, as a multimedia library, there's no need to).
In fact, the latter gives me my doubts... It seems that Doxygen becomes ugly when there's a lot of interactions between multiple systems. Like Pidgin; I have no idea how they structure protocol plugins because nothing will let me traverse what is called from the UI down. The care they'd have to put into that seems to surpass the structure of Doxygen's output...
If I used this, we'd have a very nice display of what each function does, but we'd have no illustration of what that looked like in the big picture, and we couldn't really use that to allow LGM to give users information about a function based on a downloaded INI/whatever. Unless Doxygen has some API to retrieve lists of such, but even then it would quickly turn into a clusterfuck: LGM is only concerned with docs for functions included from the main source; the ones ENIGMA users can access.
I will look into a workaround with Gary. Maybe Doxygen can cover us, or maybe we can integrate both systems. Doxygen could generate similar docs for individual functions not in main.cpp; the Markdown-like structure I proposed elsewhere could give "bigger picture" documentation and differences between key systems in GM and ENIGMA; and the database-based system Gary has already coded could provide EDL function documentation which would be available to LGM in some easily traversed format. In fact, I'm liking that idea.
We'll continue with what we've already started for now, and then we'll work on getting Doxygen up for other sources, I believe. I will have to talk this over with a2h or Gary, of course, as websites aren't really my forte.
|
|
« Last Edit: May 22, 2010, 12:10:41 pm by Josh @ Dreamland »
|
Logged
|
"That is the single most cryptic piece of code I have ever seen." -Master PobbleWobble "I disapprove of what you say, but I will defend to the death your right to say it." -Evelyn Beatrice Hall, Friends of Voltaire
|
|
|
|
|