Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Yard documentation updates.

  • Loading branch information...
commit 512c267a996aa77e3ab2184132c0ab9693c7339b 1 parent 96c4f36
Gregg Kellogg gkellogg authored
6 .gemspec
@@ -28,8 +28,8 @@ Gem::Specification.new do |gem|
28 28 gem.required_ruby_version = '>= 1.8.1'
29 29 gem.requirements = []
30 30 gem.add_runtime_dependency 'addressable', '>= 2.2.6'
31   - gem.add_development_dependency 'yard', '>= 0.7.5'
32   - gem.add_development_dependency 'rdf-spec', '~> 0.3.10'
33   - gem.add_development_dependency 'rspec', '>= 2.8.0'
  31 + gem.add_development_dependency 'yard', '>= 0.8.3'
  32 + gem.add_development_dependency 'rdf-spec', '~> 0.3.11'
  33 + gem.add_development_dependency 'rspec', '>= 2.12.0'
34 34 gem.post_install_message = nil
35 35 end
1  .gitignore
@@ -5,3 +5,4 @@ pkg
5 5 tmp
6 6 /*.gem
7 7 /.rbx/
  8 +/doc/
2  Gemfile
@@ -10,4 +10,4 @@ end
10 10
11 11 group :test do
12 12 gem "rake"
13   -end
  13 +end
8 Gemfile.lock
... ... @@ -1,6 +1,6 @@
1 1 GIT
2 2 remote: git://github.com/ruby-rdf/rdf-spec.git
3   - revision: fb50f91fbcc11ebe2a84af6f947688d09da79dbb
  3 + revision: 3116de54c1fc56e6248b2cc0b6cd2b28b95c5ea7
4 4 specs:
5 5 rdf-spec (0.3.10)
6 6 rspec (>= 2.8.0)
@@ -8,7 +8,7 @@ GIT
8 8 PATH
9 9 remote: .
10 10 specs:
11   - rdf (0.3.10)
  11 + rdf (0.3.11)
12 12 addressable (>= 2.2.6)
13 13
14 14 GEM
@@ -36,6 +36,6 @@ DEPENDENCIES
36 36 rake
37 37 rdf!
38 38 rdf-spec!
39   - rspec (>= 2.8.0)
  39 + rspec (>= 2.12.0)
40 40 wirble
41   - yard (>= 0.7.5)
  41 + yard (>= 0.8.3)
1  README.md
Source Rendered
@@ -355,6 +355,7 @@ see <http://unlicense.org/> or the accompanying {file:UNLICENSE} file.
355 355 [RDF::N3]: http://ruby-rdf.github.com/rdf-n3
356 356 [RDF::RDFa]: http://ruby-rdf.github.com/rdf-rdfa
357 357 [RDF::RDFXML]: http://ruby-rdf.github.com/rdf-rdfxml
  358 +[RDF::TriG]: http://ruby-rdf.github.com/rdf-trig
358 359 [RDF::TriX]: http://ruby-rdf.github.com/rdf-trix
359 360 [RDF::Turtle]: http://ruby-rdf.github.com/rdf-turtle
360 361 [RDF::Raptor]: http://ruby-rdf.github.com/rdf-raptor
2  VERSION
... ... @@ -1 +1 @@
1   -0.3.10
  1 +0.3.11
2  lib/rdf.rb
@@ -99,7 +99,7 @@ def self.Node(*args, &block)
99 99 # @param [URI, String, #to_s] uri
100 100 #
101 101 # @overload URI(options = {})
102   - # @param [Hash{Symbol => Object} options
  102 + # @param [Hash{Symbol => Object}] options
103 103 # passed to `Addressable::URI.new`
104 104 #
105 105 # @return [RDF::URI]
4 lib/rdf/cli.rb
@@ -166,8 +166,8 @@ def self.commands
166 166 end
167 167
168 168 ##
169   - # Parse each file, STDIN or specified string in options[:evaluate] yielding
170   - # a reader
  169 + # Parse each file, STDIN or specified string in `options[:evaluate]`
  170 + # yielding a reader
171 171 #
172 172 # @param [Array<String>] files
173 173 # @yield [reader]
18 lib/rdf/mixin/enumerable.rb
@@ -155,7 +155,7 @@ def each_statement(&block)
155 155 end
156 156
157 157 ##
158   - # Returns an enumerator for {#each_statement}.
  158 + # Returns an enumerator for {RDF::Enumerable#each_statement}.
159 159 # FIXME: enum_for doesn't seem to be working properly
160 160 # in JRuby 1.7, so specs are marked pending
161 161 #
@@ -217,7 +217,7 @@ def each_triple(&block)
217 217 end
218 218
219 219 ##
220   - # Returns an enumerator for {#each_triple}.
  220 + # Returns an enumerator for {RDF::Enumerable#each_triple}.
221 221 #
222 222 # @return [Enumerator]
223 223 # @see #each_triple
@@ -278,7 +278,7 @@ def each_quad(&block)
278 278 end
279 279
280 280 ##
281   - # Returns an enumerator for {#each_quad}.
  281 + # Returns an enumerator for {RDF::Enumerable#each_quad}.
282 282 #
283 283 # @return [Enumerator]
284 284 # @see #each_quad
@@ -346,7 +346,7 @@ def each_subject(&block)
346 346 end
347 347
348 348 ##
349   - # Returns an enumerator for {#each_subject}.
  349 + # Returns an enumerator for {RDF::Enumerable#each_subject}.
350 350 #
351 351 # @return [Enumerator]
352 352 # @see #each_subject
@@ -414,7 +414,7 @@ def each_predicate(&block)
414 414 end
415 415
416 416 ##
417   - # Returns an enumerator for {#each_predicate}.
  417 + # Returns an enumerator for {RDF::Enumerable#each_predicate}.
418 418 #
419 419 # @return [Enumerator]
420 420 # @see #each_predicate
@@ -482,7 +482,7 @@ def each_object(&block) # FIXME: deduplication
482 482 end
483 483
484 484 ##
485   - # Returns an enumerator for {#each_object}.
  485 + # Returns an enumerator for {RDF::Enumerable#each_object}.
486 486 #
487 487 # @return [Enumerator]
488 488 # @see #each_object
@@ -550,7 +550,7 @@ def each_context(&block)
550 550 end
551 551
552 552 ##
553   - # Returns an enumerator for {#each_context}.
  553 + # Returns an enumerator for {RDF::Enumerable#each_context}.
554 554 #
555 555 # @return [Enumerator]
556 556 # @see #each_context
@@ -590,7 +590,7 @@ def each_graph(&block)
590 590 end
591 591
592 592 ##
593   - # Returns an enumerator for {#each_graph}.
  593 + # Returns an enumerator for {RDF::Enumerable#each_graph}.
594 594 #
595 595 # @return [Enumerator]
596 596 # @see #each_graph
@@ -628,7 +628,7 @@ def to_set
628 628 # terms.
629 629 #
630 630 # The return value is a `Hash` instance that has the structure:
631   - # {subject => {predicate => [*objects]}`.
  631 + # `{subject => {predicate => [*objects]}}`.
632 632 #
633 633 # @return [Hash]
634 634 def to_hash
2  lib/rdf/mixin/mutable.rb
@@ -157,7 +157,7 @@ def clear
157 157 ##
158 158 # Deletes the given RDF statements from the underlying storage.
159 159 #
160   - # Defaults to invoking {#delete_statement} for each given statement.
  160 + # Defaults to invoking {RDF::Mutable#delete_statement} for each given statement.
161 161 #
162 162 # Subclasses of {RDF::Repository} may wish to override this method if
163 163 # they are capable of more efficiently deleting multiple statements at
2  lib/rdf/mixin/queryable.rb
@@ -14,7 +14,7 @@ module Queryable
14 14 ##
15 15 # Queries `self` for RDF statements matching the given `pattern`.
16 16 #
17   - # This method delegates to the protected {#query_pattern} method for the
  17 + # This method delegates to the protected {RDF::Queryable#query_pattern} method for the
18 18 # actual lower-level query pattern matching implementation.
19 19 #
20 20 # @example
6 lib/rdf/mixin/writable.rb
@@ -73,7 +73,7 @@ def insert(*statements)
73 73 # Inserts statements from the given RDF reader into the underlying
74 74 # storage or output stream.
75 75 #
76   - # Defaults to passing the reader to the {#insert_statements} method.
  76 + # Defaults to passing the reader to the {RDF::Writable#insert_statements} method.
77 77 #
78 78 # Subclasses of {RDF::Repository} may wish to override this method in
79 79 # case their underlying storage can efficiently import RDF data directly
@@ -91,7 +91,7 @@ def insert_reader(reader)
91 91 # Inserts the given RDF graph into the underlying storage or output
92 92 # stream.
93 93 #
94   - # Defaults to passing the graph to the {#insert_statements} method.
  94 + # Defaults to passing the graph to the {RDF::Writable#insert_statements} method.
95 95 #
96 96 # Subclasses of {RDF::Repository} may wish to override this method in
97 97 # case their underlying storage architecture is graph-centric rather
@@ -112,7 +112,7 @@ def insert_graph(graph)
112 112 # Inserts the given RDF statements into the underlying storage or output
113 113 # stream.
114 114 #
115   - # Defaults to invoking {#insert_statement} for each given statement.
  115 + # Defaults to invoking {RDF::Writable#insert_statement} for each given statement.
116 116 #
117 117 # Subclasses of {RDF::Repository} may wish to override this method if
118 118 # they are capable of more efficiently inserting multiple statements at
2  lib/rdf/model/literal.rb
@@ -279,7 +279,7 @@ def valid?
279 279 end
280 280
281 281 ##
282   - # Validates the value using {#valid?}, raising an error if the value is
  282 + # Validates the value using {RDF::Value#valid?}, raising an error if the value is
283 283 # invalid.
284 284 #
285 285 # @return [RDF::Literal] `self`
6 lib/rdf/model/uri.rb
@@ -122,7 +122,7 @@ def self.intern(str)
122 122 ##
123 123 # Creates a new `RDF::URI` instance based on the given `uri` string.
124 124 #
125   - # This is just an alias for {#initialize RDF::URI.new} for compatibity
  125 + # This is just an alias for {RDF::URI#initialize} for compatibity
126 126 # with `Addressable::URI.parse`.
127 127 #
128 128 # @param [String, #to_s] str
@@ -136,7 +136,7 @@ def self.parse(str)
136 136 # @param [RDF::URI, String, #to_s] uri
137 137 #
138 138 # @overload URI.new(options = {})
139   - # @param [Hash{Symbol => Object} options
  139 + # @param [Hash{Symbol => Object}] options
140 140 def initialize(uri_or_options)
141 141 case uri_or_options
142 142 when Hash
@@ -509,7 +509,7 @@ def end_with?(string)
509 509 alias_method :ends_with?, :end_with?
510 510
511 511 ##
512   - # Checks whether this URI the same term as `other'.
  512 + # Checks whether this URI the same term as `other`.
513 513 #
514 514 # @example
515 515 # RDF::URI('http://t.co/').eql?(RDF::URI('http://t.co/')) #=> true
2  lib/rdf/model/value.rb
@@ -69,7 +69,7 @@ def statement?
69 69 ##
70 70 # Returns `true` if `self` is an IRI reference.
71 71 #
72   - # By default this is simply an alias for {#uri?}.
  72 + # By default this is simply an alias for {RDF::Value#uri?}.
73 73 #
74 74 # @return [Boolean]
75 75 def iri?
2  lib/rdf/ntriples/writer.rb
@@ -4,7 +4,7 @@ module RDF::NTriples
4 4 #
5 5 # Output is serialized for UTF-8, to serialize as ASCII
6 6 # (with) unicode escapes, set :encoding => Encoding::ASCII as
7   - # an option to {#initialize}.
  7 + # an option to {RDF::NTriples::Writer#initialize}.
8 8 #
9 9 # @example Obtaining an NTriples writer class
10 10 # RDF::Writer.for(:ntriples) #=> RDF::NTriples::Writer
6 lib/rdf/query.rb
@@ -6,7 +6,7 @@ module RDF
6 6 # contexts if the name is an RDF::Term or bound RDF::Query::Variable.
7 7 # Names that are against unbound variables match either default
8 8 # or named contexts.
9   - # The name of `false' will only match against the default context.
  9 + # The name of `false` will only match against the default context.
10 10 #
11 11 # Variable names cause the variable to be added to the solution set
12 12 # elements.
@@ -131,7 +131,7 @@ def self.execute(queryable, patterns = nil, options = {}, &block)
131 131 # contexts if the name is an RDF::Term or bound RDF::Query::Variable.
132 132 # Names that are against unbound variables match either detault
133 133 # or named contexts.
134   - # The name of `false' will only match against the default context.
  134 + # The name of `false` will only match against the default context.
135 135 # @yield [query]
136 136 # @yieldparam [RDF::Query] query
137 137 # @yieldreturn [void] ignored
@@ -234,7 +234,7 @@ def optimize!(options = {})
234 234 # contexts if the name is an RDF::Term or bound RDF::Query::Variable.
235 235 # Names that are against unbound variables match either detault
236 236 # or named contexts.
237   - # The name of `false' will only match against the default context.
  237 + # The name of `false` will only match against the default context.
238 238 #
239 239 # @param [RDF::Queryable] queryable
240 240 # the graph or repository to query
2  lib/rdf/query/pattern.rb
@@ -124,7 +124,7 @@ def optional?
124 124 # If the optional `bindings` are given, variables will be substituted with their values
125 125 # when executing the query.
126 126 #
127   - # To match triples only in the default context, set context to `false'.
  127 + # To match triples only in the default context, set context to `false`.
128 128 #
129 129 # @example
130 130 # Pattern.new(:s, :p, :o).execute(RDF::Repository.load('data.nt'))
2  lib/rdf/query/solutions.rb
@@ -106,7 +106,7 @@ def filter(criteria = {}, &block)
106 106 # Reorders this solution sequence by the given `variables`.
107 107 #
108 108 # Variables may be symbols or {Query::Variable} instances.
109   - # A variable may also be a Procedure/Lambda, compatible with {::Enumerable#sort}.
  109 + # A variable may also be a Procedure/Lambda, compatible with `::Enumerable#sort`.
110 110 # This takes two arguments (solutions) and returns -1, 0, or 1 equivalently to <=>.
111 111 #
112 112 # If called with a block, variables are ignored, and the block is invoked with
2  lib/rdf/transaction.rb
@@ -83,7 +83,7 @@ def initialize(options = {}, &block)
83 83 #
84 84 # Transactions do not support the `RDF::Enumerable` protocol directly.
85 85 # To enumerate the RDF statements to be inserted or deleted, use the
86   - # {#inserts} and {#deletes} accessors.
  86 + # {RDF::Transaction#inserts} and {RDF::Transaction#deletes} accessors.
87 87 #
88 88 # @return [Boolean]
89 89 # @see RDF::Readable#readable?

0 comments on commit 512c267

Please sign in to comment.
Something went wrong with that request. Please try again.