Skip to content

Commit

Permalink
More verbose comments derived from GPGME code (#127)
Browse files Browse the repository at this point in the history
  • Loading branch information
allantokuda-zipnosis authored and dansketcher committed Dec 22, 2018
1 parent bc0ee0d commit c9e924f
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions lib/gpgme/data.rb
Original file line number Diff line number Diff line change
Expand Up @@ -165,8 +165,16 @@ def encoding
end

##
# Sets the encoding for this buffer. Accepts only values in one of the
# DATA_ENCODING_* constants.
# Sets the encoding for this buffer. Accepts only integer values 0 to 7:
#
# 0 = GPGME_DATA_ENCODING_NONE (Not specified)
# 1 = GPGME_DATA_ENCODING_BINARY
# 2 = GPGME_DATA_ENCODING_BASE64
# 3 = GPGME_DATA_ENCODING_ARMOR (Either PEM or OpenPGP Armor)
# 4 = GPGME_DATA_ENCODING_URL (LF delimited URL list)
# 5 = GPGME_DATA_ENCODING_URLESC (Ditto, but percent escaped)
# 6 = GPGME_DATA_ENCODING_URL0 (Nul delimited URL list)
# 7 = GPGME_DATA_ENCODING_MIME (Data is a MIME part)
#
# @raise [GPGME::Error::InvalidValue] if the value isn't accepted.
def encoding=(encoding)
Expand Down

0 comments on commit c9e924f

Please sign in to comment.