Skip to content

doc clarification #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sigmike wants to merge 1 commit into
base: master
Choose a base branch
from
Open

doc clarification #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions lib/ezcrypto.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,9 +364,12 @@ def on_cipher(&block)


=begin rdoc
Encrypt a file 'inplace' and add a suffix
see #cipher_file.
Encrypt a file 'inplace' and add a suffix.
IMPORTANT: The inputfile will be deleted by default.

Options:
* suffix: string added to src if tgt is not provided. Default: '.ez'
* autoclean: remove the source file if true. Default: 'true'
=end
def encrypt_file(src, tgt=nil, options = {} )
options = { :suffix => '.ez', :autoclean => 'true' }.update(options)
Expand All @@ -377,8 +380,11 @@ def encrypt_file(src, tgt=nil, options = {} )

=begin rdoc
Decrypt a file 'inplace' and remove a suffix
see #cipher_file
IMPORTANT: The inputfile will be deleted by default.

Options:
* suffix: string removed from src if tgt is not provided. Default: '.ez'
* autoclean: remove the source file if true. Default: 'true'
=end
def decrypt_file(src, tgt=nil, options = {} )
options = { :suffix => '.ez', :autoclean => 'true' }.update(options)
Expand Down