From d7c248b94e03c3ab1f8cd086e2ee44091fc0f9b6 Mon Sep 17 00:00:00 2001 From: Benjamin Neff Date: Mon, 6 Jul 2015 23:49:42 +0200 Subject: [PATCH] cleanup: remove double ## everywhere on documentation --- .../diaspora_federation/application_controller.rb | 1 - app/controllers/diaspora_federation/h_card_controller.rb | 2 -- app/controllers/diaspora_federation/receive_controller.rb | 3 --- .../diaspora_federation/webfinger_controller.rb | 4 ---- lib/diaspora_federation.rb | 5 ----- lib/diaspora_federation/engine.rb | 1 - lib/diaspora_federation/logging.rb | 2 -- lib/diaspora_federation/rails.rb | 1 - lib/diaspora_federation/version.rb | 1 - lib/diaspora_federation/web_finger.rb | 1 - lib/diaspora_federation/web_finger/exceptions.rb | 2 -- lib/diaspora_federation/web_finger/h_card.rb | 1 - lib/diaspora_federation/web_finger/host_meta.rb | 7 ------- lib/diaspora_federation/web_finger/web_finger.rb | 1 - lib/diaspora_federation/web_finger/xrd_document.rb | 3 --- 15 files changed, 35 deletions(-) diff --git a/app/controllers/diaspora_federation/application_controller.rb b/app/controllers/diaspora_federation/application_controller.rb index f625f08..f73b00e 100644 --- a/app/controllers/diaspora_federation/application_controller.rb +++ b/app/controllers/diaspora_federation/application_controller.rb @@ -1,5 +1,4 @@ module DiasporaFederation - ## # Base-Controller for all DiasporaFederation-Controller class ApplicationController < ActionController::Base end diff --git a/app/controllers/diaspora_federation/h_card_controller.rb b/app/controllers/diaspora_federation/h_card_controller.rb index bb80f1b..71a9479 100644 --- a/app/controllers/diaspora_federation/h_card_controller.rb +++ b/app/controllers/diaspora_federation/h_card_controller.rb @@ -1,10 +1,8 @@ require_dependency "diaspora_federation/application_controller" module DiasporaFederation - ## # this controller generates the hcard class HCardController < ApplicationController - ## # returns the hcard of the user # # GET /hcard/users/:guid diff --git a/app/controllers/diaspora_federation/receive_controller.rb b/app/controllers/diaspora_federation/receive_controller.rb index 5083260..733cf4d 100644 --- a/app/controllers/diaspora_federation/receive_controller.rb +++ b/app/controllers/diaspora_federation/receive_controller.rb @@ -1,12 +1,10 @@ require_dependency "diaspora_federation/application_controller" module DiasporaFederation - ## # this controller processes receiving messages class ReceiveController < ApplicationController before_action :check_for_xml - ## # receives public messages # # POST /receive/public @@ -16,7 +14,6 @@ module DiasporaFederation render nothing: true, status: :ok end - ## # receives private messages for a user # # POST /receive/users/:guid diff --git a/app/controllers/diaspora_federation/webfinger_controller.rb b/app/controllers/diaspora_federation/webfinger_controller.rb index 5456e74..461344d 100644 --- a/app/controllers/diaspora_federation/webfinger_controller.rb +++ b/app/controllers/diaspora_federation/webfinger_controller.rb @@ -1,10 +1,8 @@ require_dependency "diaspora_federation/application_controller" module DiasporaFederation - ## # this controller handles all webfinger-specific requests class WebfingerController < ApplicationController - ## # returns the host-meta xml # # example: @@ -18,7 +16,6 @@ module DiasporaFederation render body: WebfingerController.host_meta_xml, content_type: "application/xrd+xml" end - ## # @deprecated this is the pre RFC 7033 webfinger # # example: @@ -46,7 +43,6 @@ module DiasporaFederation private - ## # creates the host-meta xml with the configured server_uri and caches it # @return [String] XML string def self.host_meta_xml diff --git a/lib/diaspora_federation.rb b/lib/diaspora_federation.rb index fb78cdc..38efcf4 100644 --- a/lib/diaspora_federation.rb +++ b/lib/diaspora_federation.rb @@ -2,13 +2,11 @@ require "diaspora_federation/logging" require "diaspora_federation/web_finger" -## # diaspora* federation library module DiasporaFederation extend Logging class << self - ## # the pod url # # @example with uri @@ -17,7 +15,6 @@ module DiasporaFederation # config.server_uri = AppConfig.pod_uri attr_accessor :server_uri - ## # the class to use as +Person+ # # @example @@ -95,7 +92,6 @@ module DiasporaFederation const_get(@person_class) end - ## # configure the federation library # # DiasporaFederation.configure do |config| @@ -105,7 +101,6 @@ module DiasporaFederation yield self end - ## # validates if the engine is configured correctly # # called from after_initialize diff --git a/lib/diaspora_federation/engine.rb b/lib/diaspora_federation/engine.rb index 1a6f20c..0941467 100644 --- a/lib/diaspora_federation/engine.rb +++ b/lib/diaspora_federation/engine.rb @@ -1,5 +1,4 @@ module DiasporaFederation - ## # diaspora* federation rails engine class Engine < ::Rails::Engine isolate_namespace DiasporaFederation diff --git a/lib/diaspora_federation/logging.rb b/lib/diaspora_federation/logging.rb index 96607b5..e5a4064 100644 --- a/lib/diaspora_federation/logging.rb +++ b/lib/diaspora_federation/logging.rb @@ -1,12 +1,10 @@ module DiasporaFederation - ## # logging module for the diaspora federation # # it uses the logging-gem if available module Logging private - ## # get the logger for this class # # use the logging-gem if available, else use a default logger diff --git a/lib/diaspora_federation/rails.rb b/lib/diaspora_federation/rails.rb index 9cf3260..dd551a7 100644 --- a/lib/diaspora_federation/rails.rb +++ b/lib/diaspora_federation/rails.rb @@ -3,7 +3,6 @@ require "diaspora_federation/engine" require "diaspora_federation" module DiasporaFederation - ## # diaspora* federation rails engine module Rails end diff --git a/lib/diaspora_federation/version.rb b/lib/diaspora_federation/version.rb index 80e035b..2486f4c 100644 --- a/lib/diaspora_federation/version.rb +++ b/lib/diaspora_federation/version.rb @@ -1,5 +1,4 @@ module DiasporaFederation - ## # the gem version VERSION = "0.0.2" end diff --git a/lib/diaspora_federation/web_finger.rb b/lib/diaspora_federation/web_finger.rb index 2df92fd..f0d6222 100644 --- a/lib/diaspora_federation/web_finger.rb +++ b/lib/diaspora_federation/web_finger.rb @@ -1,5 +1,4 @@ module DiasporaFederation - ## # This module provides the namespace for the various classes implementing # WebFinger and other protocols used for metadata discovery on remote servers # in the Diaspora* network. diff --git a/lib/diaspora_federation/web_finger/exceptions.rb b/lib/diaspora_federation/web_finger/exceptions.rb index c999dc9..5883dc7 100644 --- a/lib/diaspora_federation/web_finger/exceptions.rb +++ b/lib/diaspora_federation/web_finger/exceptions.rb @@ -1,11 +1,9 @@ module DiasporaFederation module WebFinger - ## # Raised, if the XML structure is invalid class InvalidDocument < RuntimeError end - ## # Raised, if something is wrong with the webfinger data # # * if the +webfinger_url+ is missing or malformed in {HostMeta.from_base_url} or {HostMeta.from_xml} diff --git a/lib/diaspora_federation/web_finger/h_card.rb b/lib/diaspora_federation/web_finger/h_card.rb index 65081ff..61257ad 100644 --- a/lib/diaspora_federation/web_finger/h_card.rb +++ b/lib/diaspora_federation/web_finger/h_card.rb @@ -1,6 +1,5 @@ module DiasporaFederation module WebFinger - ## # This class provides the means of generating an parsing account data to and # from the hCard format. # hCard is based on +RFC 2426+ (vCard) which got superseded by +RFC 6350+. diff --git a/lib/diaspora_federation/web_finger/host_meta.rb b/lib/diaspora_federation/web_finger/host_meta.rb index 3d34a89..444c16f 100644 --- a/lib/diaspora_federation/web_finger/host_meta.rb +++ b/lib/diaspora_federation/web_finger/host_meta.rb @@ -1,7 +1,6 @@ module DiasporaFederation module WebFinger - ## # Generates and parses Host Meta documents. # # This is a minimal implementation of the standard, only to the degree of what @@ -23,7 +22,6 @@ module DiasporaFederation # URL fragment to append to the base URL WEBFINGER_SUFFIX = "webfinger?q={uri}" - ## # Returns the WebFinger URL that was used to build this instance (either from # xml or by giving a base URL). # @return [String] WebFinger template URL @@ -31,7 +29,6 @@ module DiasporaFederation @webfinger_url end - ## # Produces the XML string for the Host Meta instance with a +Link+ element # containing the +webfinger_url+. # @return [String] XML string @@ -43,7 +40,6 @@ module DiasporaFederation doc.to_xml end - ## # Builds a new HostMeta instance and constructs the WebFinger URL from the # given base URL by appending HostMeta::WEBFINGER_SUFFIX. # @return [HostMeta] @@ -60,7 +56,6 @@ module DiasporaFederation hm end - ## # Reads the given Host Meta XML document string and populates the # +webfinger_url+. # @param [String] hostmeta_xml Host Meta XML string @@ -77,7 +72,6 @@ module DiasporaFederation hm end - ## # Applies some basic sanity-checking to the given URL # @param [String] url validation subject # @return [Boolean] validation result @@ -86,7 +80,6 @@ module DiasporaFederation end private_class_method :webfinger_url_valid? - ## # Gets the webfinger url from an XRD data structure # @param [Hash] data extracted data # @return [String] webfinger url diff --git a/lib/diaspora_federation/web_finger/web_finger.rb b/lib/diaspora_federation/web_finger/web_finger.rb index 8d3afea..ad7eed3 100644 --- a/lib/diaspora_federation/web_finger/web_finger.rb +++ b/lib/diaspora_federation/web_finger/web_finger.rb @@ -1,6 +1,5 @@ module DiasporaFederation module WebFinger - ## # The WebFinger document used for Diaspora* user discovery is based on an older # draft of the specification you can find in the wiki of the "webfinger" project # on {http://code.google.com/p/webfinger/wiki/WebFingerProtocol Google Code} diff --git a/lib/diaspora_federation/web_finger/xrd_document.rb b/lib/diaspora_federation/web_finger/xrd_document.rb index 8d3dbc2..d35fbe2 100644 --- a/lib/diaspora_federation/web_finger/xrd_document.rb +++ b/lib/diaspora_federation/web_finger/xrd_document.rb @@ -1,6 +1,5 @@ module DiasporaFederation module WebFinger - ## # This class implements basic handling of XRD documents as far as it is # necessary in the context of the protocols used with Diaspora* federation. # @@ -65,7 +64,6 @@ module DiasporaFederation @properties = {} end - ## # Generates an XML document from the current instance and returns it as string # @return [String] XML document def to_xml @@ -83,7 +81,6 @@ module DiasporaFederation builder.to_xml end - ## # Parse the XRD document from the given string and create a hash containing # the extracted data. #