Skip to content

Commit

Permalink
minor edit
Browse files Browse the repository at this point in the history
update json-java jar, documentation copyedits and clarifications
  • Loading branch information
fastily committed Aug 27, 2015
1 parent eb41e17 commit bbd7804
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ JSON support is provided by [JSON-java](https://github.com/douglascrockford/JSON

##Getting Started
* [Quick Start Guide](https://github.com/fastily/jwiki/wiki/Quick-Start-Guide)
* [Javadocs](http://fastily.github.io/jwiki/docs/jwiki/)
* [Javadocs](https://fastily.github.io/jwiki/docs/jwiki/)
* Main class: [Wiki.java](https://github.com/fastily/jwiki/blob/master/src/jwiki/core/Wiki.java)

####Sample Code
Expand All @@ -42,5 +42,5 @@ public class JwikiExample
I designed jwiki with the following goals in mind:

* **Simple** - _Anybody_ with a beginner's knowledge of Java shall be able to use this framework. I avoid horrible things like complex custom objects and convoluted calls; this project isn't for showing off my Java skills - it's designed to save my users time and effort.
* **Speed** - This framework shall emphasize performance. Time is a precious resource so why spend it waiting for some dumb program to finish :)
* **Speed** - This framework shall emphasize performance. Time is precious so why spend it waiting for some dumb program to finish!
* **Succinct** - Changes and queries shall be easy to perform. I designed this framework so API calls can be constructed with one line of code consisting of simple objects and primitive types.
Binary file modified lib/JSON-java.jar
Binary file not shown.
2 changes: 1 addition & 1 deletion src/jwiki/core/Wiki.java
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ public String whoami()

/**
* Takes a Namespace prefix and gets a NS representation of it. PRECONDITION: the prefix must be a valid namespace
* prefix. WARNING: This method is CASE-SENSITIVE, so be sure to spell and capitalize the prefix <ins>exactly</ins>
* prefix. WARNING: This method is CASE-SENSITIVE, so be sure to spell and capitalize the prefix <b>exactly</b>
* as it would appear on-wiki.
*
* @param prefix The prefix to use, without the ":".
Expand Down
4 changes: 3 additions & 1 deletion src/jwiki/core/package-info.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
/**
* Contains the main classes in jwiki. Most of the classes here contain protected/private members which hide away the
* Contains the main classes in jwiki. Most of the classes here contain protected/private members which abstract the
* nasty/complicated details which do not, and should not concern the typical programmer. These classes all serve
* <code>Wiki.java</code>; for most users, this is the only class you're going to need.
*
* @author Fastily
*/
package jwiki.core;

2 changes: 2 additions & 0 deletions src/jwiki/dwrap/package-info.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
/**
* Contains data storage formats for jwiki. These are simple, immutable objects with publicly exposed accessors.
*
* @author Fastily
*/
package jwiki.dwrap;

2 changes: 2 additions & 0 deletions src/jwiki/util/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
* available in their own package for general purpose use. Contains methods ranging from I/O, to String functions, to
* GUI. There are also tools/frameworks such as FLogin/WikiGen (which provide an interface to locally save login
* credentials and encrypt them).
*
* @author Fastily
*/

package jwiki.util;
2 changes: 1 addition & 1 deletion todo.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@

* Purge should take multiple params in WAction

* Need to fix my javadocs
* Need to fix my javadocs

0 comments on commit bbd7804

Please sign in to comment.