Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Yard documentation updates.

  • Loading branch information...
commit 512c267a996aa77e3ab2184132c0ab9693c7339b 1 parent 96c4f36
@gkellogg gkellogg authored
View
6 .gemspec
@@ -28,8 +28,8 @@ Gem::Specification.new do |gem|
gem.required_ruby_version = '>= 1.8.1'
gem.requirements = []
gem.add_runtime_dependency 'addressable', '>= 2.2.6'
- gem.add_development_dependency 'yard', '>= 0.7.5'
- gem.add_development_dependency 'rdf-spec', '~> 0.3.10'
- gem.add_development_dependency 'rspec', '>= 2.8.0'
+ gem.add_development_dependency 'yard', '>= 0.8.3'
+ gem.add_development_dependency 'rdf-spec', '~> 0.3.11'
+ gem.add_development_dependency 'rspec', '>= 2.12.0'
gem.post_install_message = nil
end
View
1  .gitignore
@@ -5,3 +5,4 @@ pkg
tmp
/*.gem
/.rbx/
+/doc/
View
2  Gemfile
@@ -10,4 +10,4 @@ end
group :test do
gem "rake"
-end
+end
View
8 Gemfile.lock
@@ -1,6 +1,6 @@
GIT
remote: git://github.com/ruby-rdf/rdf-spec.git
- revision: fb50f91fbcc11ebe2a84af6f947688d09da79dbb
+ revision: 3116de54c1fc56e6248b2cc0b6cd2b28b95c5ea7
specs:
rdf-spec (0.3.10)
rspec (>= 2.8.0)
@@ -8,7 +8,7 @@ GIT
PATH
remote: .
specs:
- rdf (0.3.10)
+ rdf (0.3.11)
addressable (>= 2.2.6)
GEM
@@ -36,6 +36,6 @@ DEPENDENCIES
rake
rdf!
rdf-spec!
- rspec (>= 2.8.0)
+ rspec (>= 2.12.0)
wirble
- yard (>= 0.7.5)
+ yard (>= 0.8.3)
View
1  README.md
@@ -355,6 +355,7 @@ see <http://unlicense.org/> or the accompanying {file:UNLICENSE} file.
[RDF::N3]: http://ruby-rdf.github.com/rdf-n3
[RDF::RDFa]: http://ruby-rdf.github.com/rdf-rdfa
[RDF::RDFXML]: http://ruby-rdf.github.com/rdf-rdfxml
+[RDF::TriG]: http://ruby-rdf.github.com/rdf-trig
[RDF::TriX]: http://ruby-rdf.github.com/rdf-trix
[RDF::Turtle]: http://ruby-rdf.github.com/rdf-turtle
[RDF::Raptor]: http://ruby-rdf.github.com/rdf-raptor
View
2  VERSION
@@ -1 +1 @@
-0.3.10
+0.3.11
View
2  lib/rdf.rb
@@ -99,7 +99,7 @@ def self.Node(*args, &block)
# @param [URI, String, #to_s] uri
#
# @overload URI(options = {})
- # @param [Hash{Symbol => Object} options
+ # @param [Hash{Symbol => Object}] options
# passed to `Addressable::URI.new`
#
# @return [RDF::URI]
View
4 lib/rdf/cli.rb
@@ -166,8 +166,8 @@ def self.commands
end
##
- # Parse each file, STDIN or specified string in options[:evaluate] yielding
- # a reader
+ # Parse each file, STDIN or specified string in `options[:evaluate]`
+ # yielding a reader
#
# @param [Array<String>] files
# @yield [reader]
View
18 lib/rdf/mixin/enumerable.rb
@@ -155,7 +155,7 @@ def each_statement(&block)
end
##
- # Returns an enumerator for {#each_statement}.
+ # Returns an enumerator for {RDF::Enumerable#each_statement}.
# FIXME: enum_for doesn't seem to be working properly
# in JRuby 1.7, so specs are marked pending
#
@@ -217,7 +217,7 @@ def each_triple(&block)
end
##
- # Returns an enumerator for {#each_triple}.
+ # Returns an enumerator for {RDF::Enumerable#each_triple}.
#
# @return [Enumerator]
# @see #each_triple
@@ -278,7 +278,7 @@ def each_quad(&block)
end
##
- # Returns an enumerator for {#each_quad}.
+ # Returns an enumerator for {RDF::Enumerable#each_quad}.
#
# @return [Enumerator]
# @see #each_quad
@@ -346,7 +346,7 @@ def each_subject(&block)
end
##
- # Returns an enumerator for {#each_subject}.
+ # Returns an enumerator for {RDF::Enumerable#each_subject}.
#
# @return [Enumerator]
# @see #each_subject
@@ -414,7 +414,7 @@ def each_predicate(&block)
end
##
- # Returns an enumerator for {#each_predicate}.
+ # Returns an enumerator for {RDF::Enumerable#each_predicate}.
#
# @return [Enumerator]
# @see #each_predicate
@@ -482,7 +482,7 @@ def each_object(&block) # FIXME: deduplication
end
##
- # Returns an enumerator for {#each_object}.
+ # Returns an enumerator for {RDF::Enumerable#each_object}.
#
# @return [Enumerator]
# @see #each_object
@@ -550,7 +550,7 @@ def each_context(&block)
end
##
- # Returns an enumerator for {#each_context}.
+ # Returns an enumerator for {RDF::Enumerable#each_context}.
#
# @return [Enumerator]
# @see #each_context
@@ -590,7 +590,7 @@ def each_graph(&block)
end
##
- # Returns an enumerator for {#each_graph}.
+ # Returns an enumerator for {RDF::Enumerable#each_graph}.
#
# @return [Enumerator]
# @see #each_graph
@@ -628,7 +628,7 @@ def to_set
# terms.
#
# The return value is a `Hash` instance that has the structure:
- # {subject => {predicate => [*objects]}`.
+ # `{subject => {predicate => [*objects]}}`.
#
# @return [Hash]
def to_hash
View
2  lib/rdf/mixin/mutable.rb
@@ -157,7 +157,7 @@ def clear
##
# Deletes the given RDF statements from the underlying storage.
#
- # Defaults to invoking {#delete_statement} for each given statement.
+ # Defaults to invoking {RDF::Mutable#delete_statement} for each given statement.
#
# Subclasses of {RDF::Repository} may wish to override this method if
# they are capable of more efficiently deleting multiple statements at
View
2  lib/rdf/mixin/queryable.rb
@@ -14,7 +14,7 @@ module Queryable
##
# Queries `self` for RDF statements matching the given `pattern`.
#
- # This method delegates to the protected {#query_pattern} method for the
+ # This method delegates to the protected {RDF::Queryable#query_pattern} method for the
# actual lower-level query pattern matching implementation.
#
# @example
View
6 lib/rdf/mixin/writable.rb
@@ -73,7 +73,7 @@ def insert(*statements)
# Inserts statements from the given RDF reader into the underlying
# storage or output stream.
#
- # Defaults to passing the reader to the {#insert_statements} method.
+ # Defaults to passing the reader to the {RDF::Writable#insert_statements} method.
#
# Subclasses of {RDF::Repository} may wish to override this method in
# case their underlying storage can efficiently import RDF data directly
@@ -91,7 +91,7 @@ def insert_reader(reader)
# Inserts the given RDF graph into the underlying storage or output
# stream.
#
- # Defaults to passing the graph to the {#insert_statements} method.
+ # Defaults to passing the graph to the {RDF::Writable#insert_statements} method.
#
# Subclasses of {RDF::Repository} may wish to override this method in
# case their underlying storage architecture is graph-centric rather
@@ -112,7 +112,7 @@ def insert_graph(graph)
# Inserts the given RDF statements into the underlying storage or output
# stream.
#
- # Defaults to invoking {#insert_statement} for each given statement.
+ # Defaults to invoking {RDF::Writable#insert_statement} for each given statement.
#
# Subclasses of {RDF::Repository} may wish to override this method if
# they are capable of more efficiently inserting multiple statements at
View
2  lib/rdf/model/literal.rb
@@ -279,7 +279,7 @@ def valid?
end
##
- # Validates the value using {#valid?}, raising an error if the value is
+ # Validates the value using {RDF::Value#valid?}, raising an error if the value is
# invalid.
#
# @return [RDF::Literal] `self`
View
6 lib/rdf/model/uri.rb
@@ -122,7 +122,7 @@ def self.intern(str)
##
# Creates a new `RDF::URI` instance based on the given `uri` string.
#
- # This is just an alias for {#initialize RDF::URI.new} for compatibity
+ # This is just an alias for {RDF::URI#initialize} for compatibity
# with `Addressable::URI.parse`.
#
# @param [String, #to_s] str
@@ -136,7 +136,7 @@ def self.parse(str)
# @param [RDF::URI, String, #to_s] uri
#
# @overload URI.new(options = {})
- # @param [Hash{Symbol => Object} options
+ # @param [Hash{Symbol => Object}] options
def initialize(uri_or_options)
case uri_or_options
when Hash
@@ -509,7 +509,7 @@ def end_with?(string)
alias_method :ends_with?, :end_with?
##
- # Checks whether this URI the same term as `other'.
+ # Checks whether this URI the same term as `other`.
#
# @example
# RDF::URI('http://t.co/').eql?(RDF::URI('http://t.co/')) #=> true
View
2  lib/rdf/model/value.rb
@@ -69,7 +69,7 @@ def statement?
##
# Returns `true` if `self` is an IRI reference.
#
- # By default this is simply an alias for {#uri?}.
+ # By default this is simply an alias for {RDF::Value#uri?}.
#
# @return [Boolean]
def iri?
View
2  lib/rdf/ntriples/writer.rb
@@ -4,7 +4,7 @@ module RDF::NTriples
#
# Output is serialized for UTF-8, to serialize as ASCII
# (with) unicode escapes, set :encoding => Encoding::ASCII as
- # an option to {#initialize}.
+ # an option to {RDF::NTriples::Writer#initialize}.
#
# @example Obtaining an NTriples writer class
# RDF::Writer.for(:ntriples) #=> RDF::NTriples::Writer
View
6 lib/rdf/query.rb
@@ -6,7 +6,7 @@ module RDF
# contexts if the name is an RDF::Term or bound RDF::Query::Variable.
# Names that are against unbound variables match either default
# or named contexts.
- # The name of `false' will only match against the default context.
+ # The name of `false` will only match against the default context.
#
# Variable names cause the variable to be added to the solution set
# elements.
@@ -131,7 +131,7 @@ def self.execute(queryable, patterns = nil, options = {}, &block)
# contexts if the name is an RDF::Term or bound RDF::Query::Variable.
# Names that are against unbound variables match either detault
# or named contexts.
- # The name of `false' will only match against the default context.
+ # The name of `false` will only match against the default context.
# @yield [query]
# @yieldparam [RDF::Query] query
# @yieldreturn [void] ignored
@@ -234,7 +234,7 @@ def optimize!(options = {})
# contexts if the name is an RDF::Term or bound RDF::Query::Variable.
# Names that are against unbound variables match either detault
# or named contexts.
- # The name of `false' will only match against the default context.
+ # The name of `false` will only match against the default context.
#
# @param [RDF::Queryable] queryable
# the graph or repository to query
View
2  lib/rdf/query/pattern.rb
@@ -124,7 +124,7 @@ def optional?
# If the optional `bindings` are given, variables will be substituted with their values
# when executing the query.
#
- # To match triples only in the default context, set context to `false'.
+ # To match triples only in the default context, set context to `false`.
#
# @example
# Pattern.new(:s, :p, :o).execute(RDF::Repository.load('data.nt'))
View
2  lib/rdf/query/solutions.rb
@@ -106,7 +106,7 @@ def filter(criteria = {}, &block)
# Reorders this solution sequence by the given `variables`.
#
# Variables may be symbols or {Query::Variable} instances.
- # A variable may also be a Procedure/Lambda, compatible with {::Enumerable#sort}.
+ # A variable may also be a Procedure/Lambda, compatible with `::Enumerable#sort`.
# This takes two arguments (solutions) and returns -1, 0, or 1 equivalently to <=>.
#
# If called with a block, variables are ignored, and the block is invoked with
View
2  lib/rdf/transaction.rb
@@ -83,7 +83,7 @@ def initialize(options = {}, &block)
#
# Transactions do not support the `RDF::Enumerable` protocol directly.
# To enumerate the RDF statements to be inserted or deleted, use the
- # {#inserts} and {#deletes} accessors.
+ # {RDF::Transaction#inserts} and {RDF::Transaction#deletes} accessors.
#
# @return [Boolean]
# @see RDF::Readable#readable?
Please sign in to comment.
Something went wrong with that request. Please try again.