Sha256: 83488b12a0c17d13c38620db34f76c3f4976157ead7bacfe7b40d5dafd19733f

Contents?: true

Size: 1.76 KB

Versions: 2

Compression:

Stored size: 1.76 KB

Contents

= rdoc-tags

* https://github.com/rdoc/rdoc-tags

== DESCRIPTION:

A TAGS file generator based on http://ctags.sourceforge.net/FORMAT.  rdoc-tags
handles namespaced classes and modules, ! and ? methods, constants and
attributes better than Exuberant Ctags.

rdoc-tags includes a Hoe plugin +:rdoc_tags+ making it easy to add tag support
to your ruby project.  If you don't use Hoe you can instead use RDoc::TagsTask
to add rake tasks for building TAGS to your ruby project.

== FEATURES/PROBLEMS:

* Much slower that Exuberant Ctags
* Only outputs vim-format tags
* Only works for ruby files, not Ruby/C files

== SYNOPSIS:

  rdoc -f tags lib

== REQUIREMENTS:

* RDoc 3+

== INSTALL:

* gem install rdoc-tags

== LICENSE:

(The MIT License)

Copyright (c) 2010 Eric Hodel

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.

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
rdoc-tags-1.2 README.txt
rdoc-tags-1.1 README.txt