Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 84 lines (54 sloc) 2.116 kb
023c61cb »
2011-11-08 Initial commit
1 rdoc-sinatra
3a4854ad »
2011-11-15 I know Markdown, I swear.
2 ============
023c61cb »
2011-11-08 Initial commit
3
4 RDoc plugin for documenting Sinatra applications.
e2c5c245 »
2011-11-15 Wrote a little README and changed versioning scheme.
5
6
7 Homepage and Bugtracker
3a4854ad »
2011-11-15 I know Markdown, I swear.
8 -----------------------
e2c5c245 »
2011-11-15 Wrote a little README and changed versioning scheme.
9
10 https://github.com/rdoc/rdoc-sinatra
11
12
13 Requirements
3a4854ad »
2011-11-15 I know Markdown, I swear.
14 ------------
e2c5c245 »
2011-11-15 Wrote a little README and changed versioning scheme.
15
16 - rdoc 3+
17
18
19 Installation
3a4854ad »
2011-11-15 I know Markdown, I swear.
20 ------------
e2c5c245 »
2011-11-15 Wrote a little README and changed versioning scheme.
21
22 `$ gem install rdoc-rake`
23
24
25 Usage
3a4854ad »
2011-11-15 I know Markdown, I swear.
26 -----
e2c5c245 »
2011-11-15 Wrote a little README and changed versioning scheme.
27
28 `$ rdoc FILE_OR_DIR […]`
29
30 The plugin extracts documentation for route definitions marked with
31 a double-hash (that bit is important):
32
33 ##
34 # This is your documentation.
35 #
36 # And then some.
37 #
38 get "/foo" do
39 :yay
40 end
41
42 This plugin augments the normal RDoc Ruby parser, so that you can
43 generate the documentation along with the rest of your methods.
44
45 The route docs are placed under a fake class called Application Routes.
46
47
48 Limitations/TODO
3a4854ad »
2011-11-15 I know Markdown, I swear.
49 ----------------
e2c5c245 »
2011-11-15 Wrote a little README and changed versioning scheme.
50
51 - Currently all routes are parsed into the top-level Application Routes.
52 This'll probably change in the next version.
53 - Does not actually parse the route patterns, so parameters and so
54 on aren't documented separately (you'll just see the entire pattern).
55
56
57
58 Licence
3a4854ad »
2011-11-15 I know Markdown, I swear.
59 -------
e2c5c245 »
2011-11-15 Wrote a little README and changed versioning scheme.
60
61 (The MIT License)
62
63 Copyright (c) 2011 Eero Saynatkari
64
65 Permission is hereby granted, free of charge, to any person obtaining
66 a copy of this software and associated documentation files (the
67 'Software'), to deal in the Software without restriction, including
68 without limitation the rights to use, copy, modify, merge, publish,
69 distribute, sublicense, and/or sell copies of the Software, and to
70 permit persons to whom the Software is furnished to do so, subject to
71 the following conditions:
72
73 The above copyright notice and this permission notice shall be
74 included in all copies or substantial portions of the Software.
75
76 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
77 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
78 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
79 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
80 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
81 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
82 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
83
Something went wrong with that request. Please try again.