mark slap classes as deprecated

This commit is contained in:
Benjamin Neff 2016-02-13 22:47:23 +01:00
parent 744e194b90
commit d2cdbd2aff
3 changed files with 7 additions and 0 deletions

View file

@ -63,6 +63,7 @@ module DiasporaFederation
#
# entity = slap.entity(author_pubkey)
#
# @deprecated
class EncryptedSlap < Slap
# the key and iv if it is an encrypted slap
# @param [Hash] value hash containing the key and iv

View file

@ -1,18 +1,22 @@
module DiasporaFederation
module Salmon
# Raised, if the element containing the Magic Envelope is missing from the XML
# @deprecated
class MissingMagicEnvelope < RuntimeError
end
# Raised, if the element containing the author is empty.
# @deprecated
class MissingAuthor < RuntimeError
end
# Raised, if the element containing the header is missing from the XML
# @deprecated
class MissingHeader < RuntimeError
end
# Raised if the decrypted header has an unexpected XML structure
# @deprecated
class InvalidHeader < RuntimeError
end

View file

@ -25,6 +25,8 @@ module DiasporaFederation
# author_pubkey = however_you_retrieve_the_authors_public_key(slap.author_id)
#
# entity = slap.entity(author_pubkey)
#
# @deprecated
class Slap
# the author of the slap
# @overload author_id