better documentation

This commit is contained in:
Benjamin Neff 2015-08-01 00:52:09 +02:00
parent 096d39bc4d
commit f4fec11993
3 changed files with 3 additions and 0 deletions

View file

@ -7,6 +7,7 @@ module DiasporaFederation
# @return [String] the diaspora ID of the account # @return [String] the diaspora ID of the account
attr_reader :diaspora_id attr_reader :diaspora_id
# create a discovery class for the diaspora-id
# @param [String] diaspora_id the diaspora id to discover # @param [String] diaspora_id the diaspora id to discover
def initialize(diaspora_id) def initialize(diaspora_id)
@diaspora_id = clean_diaspora_id(diaspora_id) @diaspora_id = clean_diaspora_id(diaspora_id)

View file

@ -19,6 +19,7 @@ module DiasporaFederation
class HostMeta class HostMeta
private_class_method :new private_class_method :new
# create a new host-meta instance
# @param [String] webfinger_url the webfinger-url # @param [String] webfinger_url the webfinger-url
def initialize(webfinger_url) def initialize(webfinger_url)
@webfinger_url = webfinger_url @webfinger_url = webfinger_url

View file

@ -8,6 +8,7 @@ module Validation
# @return [Hash] params # @return [Hash] params
attr_reader :params attr_reader :params
# create a new rule for a maximum tag count validation
# @param [Hash] params # @param [Hash] params
# @option params [Fixnum] :maximum maximum allowed tag count # @option params [Fixnum] :maximum maximum allowed tag count
def initialize(params) def initialize(params)