rdoc-sinatra

KO | EN

gitlite — search

#go #mysql #security #java #postgresql #electron #dotnet #openai #docker #gpt

(★ 8)

No description available.

파일 탐색기

ZIP 다운로드

- - discover.rb
- test_rdoc_parser_sinatra.rb
.autotest
.gemtest
.gitignore
Gemfile
Rakefile
rdoc-sinatra.gemspec
README.md

# CDN으로 사용하기

jsDelivr

jsDelivr는 공개 GitHub 리포지토리를 별도 설정 없이 CDN으로 즉시 서빙합니다. 버전과 파일을 고르면 웹페이지에 바로 붙일 수 있는 링크와 예시 코드가 만들어집니다.

버전

파일

링크

예시

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

rdoc-sinatra
============

RDoc plugin for documenting Sinatra applications.

Homepage and Bugtracker
-----------------------

https://github.com/rdoc/rdoc-sinatra

Requirements
------------

- rdoc 3+

Installation
------------

`$ gem install rdoc-sinatra`

Usage
-----

`$ rdoc FILE_OR_DIR […]`

The plugin extracts documentation for route definitions marked with
a double-hash (that bit is important):

##
    #
    # And then some.
    #
    get "/foo" do
      :yay
    end

This plugin augments the normal RDoc Ruby parser, so that you can
generate the documentation along with the rest of your methods.

The route docs are placed under a fake class called Application Routes.

Limitations/TODO
----------------

- Currently all routes are parsed into the top-level Application Routes.
This'll probably change in the next version.
- Does not actually parse the route patterns, so parameters and so
on aren't documented separately (you'll just see the entire pattern).

Licence
-------

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

rdoc-sinatra

오너의 다른 레포

파일 탐색기

# CDN으로 사용하기

Was this content helpful?

Recent Feedback

rdoc-sinatra

오너의 다른 레포

파일 탐색기

# CDN으로 사용하기

Was this content helpful?

Recent Feedback

Download README