PDA

View Full Version : Two Documentation Requests.



ProfessorM@ss
Dec 21st, '04, 06:28 PM
I have two documentation requests.

Not a new copy of the user manual, for certain...but it'd be nice to have a copy of the Export Tags and Template tags with a brief explanation of how they're used. The manual seems a bit out of date in regards to that. I mean, even point-form notes in a spreadsheet would be nice. Things like the regex tags and the math tags could really use a bit of explanation.

Also, a slightly longer walkthrough on building plugins for HD would be grand. The existing documentation is okay, but even an experienced Java programmer might be a wee bit confused. Some examples and such would be exceedingly helpful.

Anyhow, I know you're terribly busy, so these are just some thoughts I've been having that might get more templates built, and more plugins built, which would really rock.

PS: Both of these things would be something I'd be willing to help produce, if that suits ya.

--->M@ss

Simon
Dec 21st, '04, 06:31 PM
Java plugins are really best kept to specific questions and answers....apart form the JavaDoc and the "instructions" on the plugins page, anything else would be a near-book on how to program....

For anyone looking to write plugins, I'm more than happy to answer questions...and even modify areas of the app as needed.

ProfessorM@ss
Dec 21st, '04, 06:33 PM
For anyone looking to write plugins, I'm more than happy to answer questions...and even modify areas of the app as needed.

Weeeeelll...let's say I asked you a bunch of questions, and then built a document from it for other HD plugin creators to view, something that could go on the site here, perhaps. Would that possibly meet with your approval?

--->M@ss

Simon
Dec 21st, '04, 06:35 PM
Depends on the number and complexity/applicability of the questions.

I'm happy helping people to write plugins....but I don't want to co-author a small book.

ProfessorM@ss
Dec 21st, '04, 06:36 PM
Depends on the number and complexity/applicability of the questions.

I'm happy helping people to write plugins....but I don't want to co-author a small book.

No, no. I'm just thinking of some basic stuff. You'll see what I mean, and can always tell me bugger off if it gets too complex.

On that note...is the Javadoc on this site up-to-date?

--->M@ss

Simon
Dec 21st, '04, 06:36 PM
On that note...is the Javadoc on this site up-to-date?
Bugger off.

Simon
Dec 21st, '04, 06:37 PM
Sorry...couldn't resist ;)

The Javadoc is a bit out of date....if needed, I can re-generate it.

ProfessorM@ss
Dec 21st, '04, 06:37 PM
Bugger off.

BWAHAHA!

I just spurted Coke out my nose. It burns.

--->M@ss

ProfessorM@ss
Dec 21st, '04, 06:38 PM
The Javadoc is a bit out of date....if needed, I can re-generate it.

If it wouldn't be too much trouble, that'd be grand. I've got some time between now and early January, and I'm rolling up my sleeves to do some plugin writing.

--->M@ss

Simon
Dec 21st, '04, 06:42 PM
I'll likely need to get that done over the weekend (or tomorrow night, whichever comes first)....It takes a while to generate and upload.

The existing javadoc is more or less up to date....just some new classes added in (power instances, etc) and a couple of tweaks in visibility/scope.

ProfessorM@ss
Dec 21st, '04, 08:42 PM
I'll likely need to get that done over the weekend (or tomorrow night, whichever comes first)....It takes a while to generate and upload.

The existing javadoc is more or less up to date....just some new classes added in (power instances, etc) and a couple of tweaks in visibility/scope.

Cool. I'll start working, in the meantime. And thanks again, Dan!

--->M@ss

Simon
Dec 22nd, '04, 02:53 PM
Javadoc has been updated....nothing incredibly detailed, but it let's you know what's there and what's available.

ProfessorM@ss
Dec 22nd, '04, 08:03 PM
Javadoc has been updated....nothing incredibly detailed, but it let's you know what's there and what's available.

You, sir, are a machine.

Thanks!

--->M@ss