Skip to content

Commit

Permalink
minor documentation cosmetics
Browse files Browse the repository at this point in the history
  • Loading branch information
mbartosch committed Feb 16, 2021
1 parent a9501c0 commit 5843d53
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 23 deletions.
12 changes: 4 additions & 8 deletions core/server/OpenXPKI/Template/Plugin/CheckDNS.pm
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
package OpenXPKI::Template::Plugin::CheckDNS;

=head1 NAME
=head1 OpenXPKI::Template::Plugin::CheckDNS
OpenXPKI::Template::Plugin::CheckDNS
=head1 DESCRIPTION
=head2 How to use
Plugin for Template::Toolkit to check FQDNs against DNS.
Expand Down Expand Up @@ -99,9 +97,7 @@ sub _init_dns {
return $rr;
}

=head2 Methods
=head3 valid
=head2 valid
Expects the fqdn to check as argument. Returns the fqdn wrapped into a
span element with css class I<dns-failed>, I<dns-valid>, I<dns-timeout> or
Expand Down Expand Up @@ -158,7 +154,7 @@ sub valid {

}

=head3 resolve
=head2 resolve
Expects the fqdn to check as argument. The result of the dns lookup is
appended to the fqdn using brackets. By default, the first result is
Expand Down
18 changes: 3 additions & 15 deletions core/server/OpenXPKI/Template/Plugin/RandomPassword.pm
Original file line number Diff line number Diff line change
Expand Up @@ -148,16 +148,12 @@ sub generate {
1;
__END__
=head1 NAME
OpenXPKI::Template::Plugin::RandomPassword
=head1 DESCRIPTION
=head1 OpenXPKI::Template::Plugin::RandomPassword
This module implements a Template Toolkit plugin that generates randomly
generated passwords in RFC2307 syntax.
=head2 USAGE
=head2 How to use
In your template, use the following line at the beginning of the file to
load the plugin:
Expand All @@ -175,15 +171,7 @@ password instance variable. It passes the named parameters 'scheme' and
'callback' to the function. The return value of the method is rendered
into the template output.
=head2 Constructor
=head3 new
Called by the Template toolkit when instantiating the plugin.
=head2 Methods
=head3 generate
=head2 generate
Generates a random password and returns the encrypted value.
Expand Down

0 comments on commit 5843d53

Please sign in to comment.