Commits

Michael Granger  committed c634b27

RDoc update, remove some leftover Yard crap.

  • Participants
  • Parent commits 4f51262

Comments (0)

Files changed (9)

 ChangeLog
 ^\.yardoc/
 ^release\.ann$
+doc/

File History.md

-## 1.1.1 [2010-12-30] Michael Granger <ged@FaerieMUD.org>
-
-* Updated for link-grammar 4.7.1.
-* Fixed some specs that were doing nothing, using old RSpec syntax, etc.
-* Converted to Hoe.
-
-
-## 1.1.0 [2010-11-30] Michael Granger <ged@FaerieMUD.org>
-
-* Updated to support link-grammar 4.7.0. Note that this breaks compatibility with
-  earlier versions, as the model for sentences with conjunctions has changed 
-  significantly.
-* Use pkgconfig if available.
-* Various memory-management and 1.9.2 fixes.
-
-
-

File History.rdoc

+== v1.1.4 [2012-01-31] Michael Granger <ged@FaerieMUD.org>
+
+- Packaging fixes, dependency update
+
+
+== v1.1.3 [2011-05-16] Michael Granger <ged@FaerieMUD.org>
+
+- Use a relative path for path constants (Alessandro Berardi), update
+  deps
+
+
+== v1.1.2 [2011-05-12] Michael Granger <ged@FaerieMUD.org>
+
+- Fixes package configuration options concatenation bug (see
+  http://goo.gl/G49Y8) (Alessandro Berardi <berardialessandro@gmail.com>)
+- De-Yard, build cleanup, added gem-testers support
+- Removed unnecessary (and non-existant on Ruby < 1.9) include.
+- Fixing some shadowed variables for 1.9.2.
+- Avoid circular requires.
+
+
+== v1.1.1 [2010-12-30] Michael Granger <ged@FaerieMUD.org>
+
+* Updated for link-grammar 4.7.1.
+* Fixed some specs that were doing nothing, using old RSpec syntax, etc.
+* Converted to Hoe.
+
+
+== v1.1.0 [2010-11-30] Michael Granger <ged@FaerieMUD.org>
+
+* Updated to support link-grammar 4.7.0. Note that this breaks compatibility with
+  earlier versions, as the model for sentences with conjunctions has changed 
+  significantly.
+* Use pkgconfig if available.
+* Various memory-management and 1.9.2 fixes.
+
+
+== v1.0.6 [2009-10-16] Michael Granger <ged@FaerieMUD.org>
+
+[TODO]
+

File Manifest.txt

 .gemtest
 ChangeLog
-History.md
+History.rdoc
 LICENSE
 Manifest.txt
-README.md
+README.rdoc
 Rakefile
 examples/basic-api.rb
 examples/readme-example.rb

File README.md

-# linkparser
-
-* http://deveiate.org/projects/Ruby-LinkParser
-
-## Description
-
-This module is a Ruby binding for [the Abiword version][abiword] of CMU's 
-[Link Grammar][link-grammar], a syntactic parser of English. 
-
-
-### Example Usage
-
-	require 'linkparser'
-	
-	dict = LinkParser::Dictionary.new( :screen_width => 100 )
-	sent = dict.parse( "People use Ruby for all kinds of nifty things." )
-	# => #<LinkParser::Sentence:0xcf8eb "LEFT-WALL people use Ruby for all kinds
-	#      of nifty things . RIGHT-WALL"/2 linkages/0 nulls>
-	
-	sent.subject        # => "people"
-	sent.verb           # => "use"
-	sent.object         # => "Ruby"
-	
-	puts sent.constituent_tree_string
-	# =>
-	# (S (NP People)
-	#    (VP use
-	#        (NP Ruby)
-	#        (PP for
-	#            (NP (NP all kinds)
-	#                (PP of
-	#                    (NP nifty things)))))
-	#    .)
-	
-	puts sent.diagram
-	# =>
-	#     +-------------------------------Xp------------------------------+
-	#     |                +----MVp---+----Jp----+     +------Jp-----+    |
-	#     +----Wd---+--Sp--+--Os-+    |    +-Dmc-+--Mp-+    +----A---+    |
-	#     |         |      |     |    |    |     |     |    |        |    |
-	# LEFT-WALL people.p use.v Ruby for.p all kinds.n of nifty.a things.n . 
-
-
-## Installation
-
-First, download and install the latest version of the link-grammar 
-library from [Abiword's site][abiword-dl].
-
-Then install the gem:
-
-    gem install linkparser
-
-You may need to specify the path to the link-grammar library if you 
-installed it somewhere that your linker doesn't look by default:
-
-    gem install linkparser -- --with-link-grammar=/usr/local
-
-
-## Contributing
-
-You can check out the current development source [with Mercurial][hg-repo],
-or if you prefer Git, via [its Github mirror][github-mirror].
-
-After checking out the source, run:
-
-	$ rake newb
-
-This task will install any missing dependencies, run the tests/specs,
-and generate the API documentation.
-
-
-## License
-
-Copyright (c) 2006-2011, The FaerieMUD Consortium
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice,
-  this list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
-
-* Neither the name of the author/s, nor the names of the project's
-  contributors may be used to endorse or promote products derived from this
-  software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-
-[abiword]:http://www.abisource.com/projects/link-grammar/
-[link-grammar]:http://www.link.cs.cmu.edu/link/ "Link Grammar"
-[abiword-dl]:http://www.abisource.com/projects/link-grammar/#download
-[hg-repo]:http://repo.deveiate.org/LinkParser
-[github-mirror]:http://github.com/ged/linkparser
+= linkparser
+
+* http://deveiate.org/projects/Ruby-LinkParser
+
+== Description
+
+This module is a Ruby binding for 
+{the Abiword version}[http://www.abisource.com/projects/link-grammar/] of CMU's
+{Link Grammar}[http://www.link.cs.cmu.edu/link/], a syntactic parser of English.
+
+
+=== Example Usage
+
+	require 'linkparser'
+	
+	dict = LinkParser::Dictionary.new( :screen_width => 100 )
+	sent = dict.parse( "People use Ruby for all kinds of nifty things." )
+	# => #<LinkParser::Sentence:0xcf8eb "LEFT-WALL people use Ruby for all kinds
+	#      of nifty things . RIGHT-WALL"/2 linkages/0 nulls>
+	
+	sent.subject        # => "people"
+	sent.verb           # => "use"
+	sent.object         # => "Ruby"
+	
+	puts sent.constituent_tree_string
+	# =>
+	# (S (NP People)
+	#    (VP use
+	#        (NP Ruby)
+	#        (PP for
+	#            (NP (NP all kinds)
+	#                (PP of
+	#                    (NP nifty things)))))
+	#    .)
+	
+	puts sent.diagram
+	# =>
+	#     +-------------------------------Xp------------------------------+
+	#     |                +----MVp---+----Jp----+     +------Jp-----+    |
+	#     +----Wd---+--Sp--+--Os-+    |    +-Dmc-+--Mp-+    +----A---+    |
+	#     |         |      |     |    |    |     |     |    |        |    |
+	# LEFT-WALL people.p use.v Ruby for.p all kinds.n of nifty.a things.n . 
+
+
+== Installation
+
+First, download and install the latest version of the link-grammar 
+library from 
+{Abiword's site}[http://www.abisource.com/projects/link-grammar/#download].
+
+Then install the gem:
+
+    gem install linkparser
+
+You may need to specify the path to the link-grammar library if you 
+installed it somewhere that your linker doesn't look by default:
+
+    gem install linkparser -- --with-link-grammar=/usr/local
+
+
+== Contributing
+
+You can check out the current development source
+{with Mercurial}[http://repo.deveiate.org/LinkParser],
+or if you prefer Git, via
+{its Github mirror}[http://github.com/ged/linkparser].
+
+After checking out the source, run:
+
+	$ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the API documentation.
+
+
+== License
+
+Copyright (c) 2006-2012, The FaerieMUD Consortium
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the author/s, nor the names of the project's
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
 
 # Main gem configuration
 hoespec = Hoe.spec 'linkparser' do
-	self.readme_file = 'README.md'
-	self.history_file = 'History.md'
+	self.readme_file = 'README.rdoc'
+	self.history_file = 'History.rdoc'
+	self.extra_rdoc_files = FileList[ '*.rdoc' ]
 
 	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
 	self.developer 'Martin Chase', 'stillflame@FaerieMUD.org'

File lib/linkparser.rb

 #!/usr/bin/ruby
 
 # The LinkParser top-level namespace.
-#  
-# @author Michael Granger <ged@FaerieMUD.org>
-# @author Martin Chase <stillflame@FaerieMUD.org>
-#  
+#
+# == Author/s
+# * Michael Granger <ged@FaerieMUD.org>
+# * Martin Chase <stillflame@FaerieMUD.org>
+#
 module LinkParser
 
 	# Release version
-	VERSION = '1.1.3'
+	VERSION = '1.1.4'
 
 	# Load the correct version if it's a Windows binary gem
 	if RUBY_PLATFORM =~/(mswin|mingw)/i

File lib/linkparser/mixins.rb

 
 		### Make a wrapper for a deprecated method. The wrapper will print a deprecation warning
 		### to STDERR, and then call the method with the same name prefixed with an underscore.
-		### @param [Symbol, #to_sym] name  the name of the method to deprecate.
 		def deprecated_method( *names )
 			names.each do |name|
 				method_body = lambda do |*args|