From c0abdec5f56387bc119e52b9ad1f45a91ffcc4d4 Mon Sep 17 00:00:00 2001 From: Christine Dodrill Date: Wed, 12 Aug 2015 17:30:44 -0700 Subject: [PATCH] Add nimdoc documentation --- static/nim.html | 1280 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 1280 insertions(+) create mode 100644 static/nim.html diff --git a/static/nim.html b/static/nim.html new file mode 100644 index 0000000..b3aaee9 --- /dev/null +++ b/static/nim.html @@ -0,0 +1,1280 @@ + + + + + + + + + + + + + + + +Module ponyapi + + + + +
+
+

Module ponyapi

+
+
+ + +
+
+

A bunch of glue for Nim applications to query PonyAPI.

+ +
+

Types

+
+
Episode = object of RootObj
+  name*: string               ## Episode name
+  air_date*: int              ## Air date in unix time
+  season*: int                ## season number of the episode
+  episode*: int               ## the episode number in the season
+  is_movie*: bool             ## does this record represent a movie?
+
+
+An episode of My Little Pony: Friendship is Magic + +
+ +
+
+

Procs

+
+
proc newest(): Episode {.raises: [ValueError, OSError, HttpRequestError, 
+                                  OverflowError, TimeoutError, ProtocolError, 
+                                  Exception, JsonParsingError], 
+                         tags: [ReadIOEffect, WriteIOEffect, TimeEffect].}
+
+returns information on the newest episode of My Little Pony: Friendship is Magic. + +
+
proc random(): Episode {.raises: [ValueError, OSError, HttpRequestError, 
+                                  OverflowError, TimeoutError, ProtocolError, 
+                                  Exception, JsonParsingError], 
+                         tags: [ReadIOEffect, WriteIOEffect, TimeEffect].}
+
+returns information on a random episode. + +
+
proc get_episode(season, episode: int): Episode {.raises: [ValueError, OSError, 
+    HttpRequestError, OverflowError, TimeoutError, ProtocolError, Exception, 
+    JsonParsingError], tags: [ReadIOEffect, WriteIOEffect, TimeEffect].}
+
+return an arbitrary episode by season, episode pair. + +
+
proc all_episodes(): seq[Episode] {.raises: [ValueError, OSError, 
+    HttpRequestError, OverflowError, TimeoutError, ProtocolError, Exception, 
+    JsonParsingError], tags: [ReadIOEffect, WriteIOEffect, TimeEffect].}
+
+return all information on all episodes. + +
+
proc get_season(season: int): seq[Episode] {.raises: [ValueError, OSError, 
+    HttpRequestError, OverflowError, TimeoutError, ProtocolError, Exception, 
+    JsonParsingError], tags: [ReadIOEffect, WriteIOEffect, TimeEffect].}
+
+return all information on a single season. + +
+ +
+searches for episodes by the given query term. + +
+ +
+ +
+
+ +
+
+ +
+ Made with Nim. Generated: 2015-08-12 17:29:43 UTC +
+
+
+
+ + +