Cleanup some doc strings and fix URLs.

Author: gkellogg

etc/doap.ttl

@@ -8,17 +8,17 @@
 
 <rdf-ldp> a doap:Project ;
   doap:name          "RDF::LDP" ;
-  doap:homepage      <http://rubygems.org/gems/rdf-ldp> ;
-  doap:license       <http://creativecommons.org/licenses/publicdomain/> ;
+  doap:homepage      <https://github.com/ruby-rdf/rdf-ldp> ;
+  doap:license       <https://creativecommons.org/licenses/publicdomain/> ;
   doap:shortdesc     "A suite of LDP software and middleware for RDF.rb" ;
   doap:description   "Implements a Linked Data Platform domain model, Rack middleware for server implementers, and a simple Sinatra-based server for RDF.rb" ;
   doap:created       "2015-07-17"^^xsd:date ;
-  doap:platform      "Ruby" ;
+  doap:programming-language "Ruby" ;
   doap:category      <http://dbpedia.org/resource/Resource_Description_Framework>,
                      <http://dbpedia.org/resource/Linked_Data_Platform>,
                      <http://dbpedia.org/resource/Ruby_(programming_language)> ;
   doap:implements    <http://www.w3.org/TR/ldp/> ;
-  doap:bug-database  <http://github.com/ruby-rdf/rdf-ldp/issues> ;
+  doap:bug-database  <https://github.com/ruby-rdf/rdf-ldp/issues> ;
   doap:vendor        <https://github.com/orgs/ruby-rdf/teams/ldp#team> ;
   doap:developer     <https://github.com/no-reply#self> ;
   doap:maintainer    <https://github.com/no-reply#self> ;
@@ -28,16 +28,16 @@
 
 <lamprey> a doap:Project ;
   doap:name          "Lamprey" ;
-  doap:homepage      <http://rubygems.org/gems/rdf-ldp> ;
+  doap:homepage      <https://rubygems.org/gems/rdf-ldp> ;
   doap:license       <http://creativecommons.org/licenses/publicdomain/> ;
   doap:shortdesc     "A Ruby LDP server based on RDF.rb, RDF::LDP, and Sinatra." ;
   doap:created       "2015-07-17"^^xsd:date ;
-  doap:platform      "Ruby" ;
+  doap:programming-language "Ruby" ;
   doap:category      <http://dbpedia.org/resource/Resource_Description_Framework>,
                      <http://dbpedia.org/resource/Linked_Data_Platform>,
                      <http://dbpedia.org/resource/Ruby_(programming_language)> ;
   doap:implements    <http://www.w3.org/TR/ldp/> ;
-  doap:bug-database  <http://github.com/ruby-rdf/rdf-ldp/issues> ;
+  doap:bug-database  <https://github.com/ruby-rdf/rdf-ldp/issues> ;
   doap:vendor        <https://github.com/orgs/ruby-rdf/teams/ldp#team> ;
   doap:developer     <https://github.com/no-reply#self> ;
   doap:maintainer    <https://github.com/no-reply#self> ;

lib/rack/ldp.rb

@@ -108,10 +108,10 @@ def call(env)
     end
 
     ##
-    # Specializes {Rack::LinkedData::ContentNegotiation}, making the default
+    # Specializes `Rack::LinkedData::ContentNegotiation`, making the default
     # return type 'text/turtle'.
     #
-    # @see Rack::LinkedData::ContentNegotiation}, making
+    # @see Rack::LinkedData::ContentNegotiation, making
     class ContentNegotiation < Rack::LinkedData::ContentNegotiation
       DEFAULT_PREFIXES =
         Hash[*::RDF::Vocabulary.map { |v| [v.__prefix__, v.to_uri] }.flatten]

lib/rdf/ldp/container.rb

@@ -69,9 +69,10 @@ def update(input, content_type, &block)
     # containment triple is completed when the transaction closes; otherwise it
     # is handled atomically.
     #
-    # @param [RDF::Term] a new member for this container
-    # @param transaction [RDF::Transaction] an active transaction as context for
-    #   the addition
+    # @param [RDF::Term] resource
+    #   a new member for this container
+    # @param transaction [RDF::Transaction] transaction
+    #   an active transaction as context for the addition
     # @return [Container] self
     def add(resource, transaction = nil)
       add_containment_triple(resource.to_uri, transaction)
@@ -85,9 +86,10 @@ def add(resource, transaction = nil)
     # containment triple is completed when the transaction closes; otherwise it
     # is handled atomically.
     #
-    # @param [RDF::Term] a new member for this container
-    # @param transaction [RDF::Transaction] an active transaction as context for
-    #   the removal
+    # @param [RDF::Term] resource
+    #   a new member for this container
+    # @param transaction [RDF::Transaction] transaction
+    #   an active transaction as context for the removal
     # @return [Container] self
     def remove(resource, transaction = nil)
       remove_containment_triple(resource.to_uri, transaction)
@@ -140,9 +142,11 @@ def remove_containment_triple(resource, transaction = nil)
     end
 
     ##
-    # @param [RDF::Term] a member to be represented in the containment triple
+    # @param [RDF::Term] resource
+    #   a member to be represented in the containment triple
     #
-    # @return [RDF::URI] the containment triple, with a graph_name pointing
+    # @return [RDF::URI]
+    #   the containment triple, with a graph_name pointing
     #   to `#graph`
     def make_containment_triple(resource)
       RDF::Statement(subject_uri, CONTAINS_URI, resource,

lib/rdf/ldp/non_rdf_source.rb

@@ -27,7 +27,9 @@ class NonRDFSource < Resource
     FORMAT_TERM = RDF::Vocab::DC11.format.freeze
 
     ##
-    # @param [storage_adapter] a class implementing the StorageAdapter interface
+    # @param [RDF::URI] subject_uri
+    # @param [RDF::Queryable] data
+    # @param [StorageAdapter] storage_adapter a class implementing the StorageAdapter interface
     #
     # @see RDF::LDP::Resource#initialize
     def initialize(subject_uri,
@@ -111,7 +113,7 @@ def description_uri
     ##
     # Sets the MIME type for the resource in `metagraph`.
     #
-    # @param [String] a string representing the content type for this LDP-NR.
+    # @param [String] content_type a string representing the content type for this LDP-NR.
     #   This SHOULD be a regisered MIME type.
     #
     # @return [StorageAdapter] the content type

lib/rdf/ldp/resource.rb

@@ -110,7 +110,7 @@ def to_uri
       ##
       # Creates an unique id (URI Slug) for a resource.
       #
-      # @note the current implementation uses {SecureRandom#uuid}.
+      # @note the current implementation uses `SecureRandom#uuid`.
       #
       # @return [String] a unique ID
       def gen_id
@@ -203,9 +203,9 @@ def initialize(subject_uri, data = RDF::Repository.new)
     ##
     # @abstract creates the resource
     #
-    # @param [IO, File] input  input (usually from a Rack env's
+    # @param [IO, File] _input  input (usually from a Rack env's
     #   `rack.input` key) used to determine the Resource's initial state.
-    # @param [#to_s] content_type  a MIME content_type used to interpret the
+    # @param [#to_s] _content_type  a MIME content_type used to interpret the
     #   input. This MAY be used as a content type for the created Resource
     #   (especially for `LDP::NonRDFSource`s).
     #