Jump to content

OpenPeripheral Documentation! (With generator from source)


1 reply to this topic

#1 ShadowZ

  • New Members
  • 1 posts

Posted 21 April 2014 - 01:02 AM

Are you a fan of OpenPeripherals?
Are you sick and tired of unreadable in-game documentation?

So do I!

What is it?
I made a simple Java documentation generator for openPeripherals. Yup, thats right.
It's using annotations to describe methods, and should work fine.

I didn't really have time to test it, if you happen to find a bug, post it here.

There are few ways to get the doc, depending on what you need.

1. Online version:
Best choice if you happen to have internet access from everywhere, no download and you don't need to update (I will).

2. Offline version:
Take it everywhere! If there are any updates, remember to download the lastest version! Online doc will be updated by me.

3. Generate by yourself:
Hardcode option, for true pr0s.
You need openPeripherals source, extracted zip. Place the jar at main dir, next to src folder. Run it from there, and you should have new folder 'doc' generated!

It looks ugly!
Still better than in computer, huh? Anyway, I know that it looks bad.
BUT, if you know some CSS... All documents load style.css which is not currently present (I can't do that well, and I should go to sleep now)... All CSS classes are listed here: http://pastebin.com/PuzenX1Z. If you can make a good-looking css, please post it here, I will add it to official release, asap.

This is non-obfuscated pure java with no dependencies. Go on and decompile, if for some reason you don't/can't do that, PM me, I'm happy to share it. You should previously know one thing, it's my evening work, it took me 3 hours to complete, don't expect perfect code. I only cared about intendation (that hurts my eyes), varriable names and code flow are weird. I didn't even care to optimize it, not worth my job (reduce execution by 50ms with next 3 hours of development? No, thanks). Anyway, a lot of the code is self-explainatory, and I'm sure there are few things that may be changed easily.

Hope you enjoy!

#2 Lyqyd

    Lua Liquidator

  • Moderators
  • 8,423 posts

Posted 21 April 2014 - 05:48 AM

Moved to Peripheral Help & Discussion.

1 user(s) are reading this topic

0 members, 1 guests, 0 anonymous users