-%
-% my( $agentnum, %opt ) = @_;
-%
-% my @agents;
-% if ( $opt{'agents'} ) {
-% #@agents = @{ $opt{'agents'} };
-% #here is the agent virtualization
-% my $agentnums_href = $FS::CurrentUser::CurrentUser->agentnums_href;
-% @agents = grep $agentnums_href->{$_->agentnum}, @{ $opt{'agents'} };
-% delete $opt{'agents'};
-% } else {
-% @agents = $FS::CurrentUser::CurrentUser->agents;
-% }
-%
-%
+<%doc>
+
+Example:
+
+ include( '/elements/tr-select-agent.html',
+
+ #recommended to keep things "sticky" on errors
+ 'curr_value' => $curr_value,
+
+ ##
+ # optional
+ ##
+
+ 'label' => 'Agent for this thing',
+ 'empty_label' => 'Select agent', #override default
+ 'disable_empty' => 1,
+
+ #set to 'None' or something to override default of showing all agents
+ #for employees w/ 'View customers of all agents' right
+ viewall_right => 'None',
+
+ );
+
+</%doc>