diff options
author | Mitch Jackson <mitch@freeside.biz> | 2019-02-16 20:20:54 -0500 |
---|---|---|
committer | Mitch Jackson <mitch@freeside.biz> | 2019-02-16 20:25:35 -0500 |
commit | 772656864b377bbd2ef2febd40891ef1206b5be0 (patch) | |
tree | a97981fda3131cda6e8ef412fa5a2616cf6d45c7 /FS/FS | |
parent | 70a5e47201ffd625d0b146af9ce407d285619690 (diff) |
RT# 81961 Repair broken links in POD documentation
- Update many links
- chmod a+x scripts in FS/bin, so Pod::Simple::HTMLBatch will
parse them for POD documentation
Diffstat (limited to 'FS/FS')
-rw-r--r-- | FS/FS/ClientAPI.pm | 14 | ||||
-rw-r--r-- | FS/FS/Cron/upload.pm | 2 | ||||
-rw-r--r-- | FS/FS/PagedSearch.pm | 2 | ||||
-rw-r--r-- | FS/FS/Template_Mixin.pm | 2 | ||||
-rw-r--r-- | FS/FS/UI/Web.pm | 4 | ||||
-rw-r--r-- | FS/FS/cust_bill.pm | 6 | ||||
-rw-r--r-- | FS/FS/cust_bill_pkg_void.pm | 2 | ||||
-rw-r--r-- | FS/FS/cust_bill_void.pm | 4 | ||||
-rw-r--r-- | FS/FS/cust_credit.pm | 4 | ||||
-rw-r--r-- | FS/FS/cust_credit_bill_pkg.pm | 2 | ||||
-rw-r--r-- | FS/FS/cust_main.pm | 6 | ||||
-rw-r--r-- | FS/FS/cust_main_Mixin.pm | 2 | ||||
-rw-r--r-- | FS/FS/cust_pay_batch.pm | 6 | ||||
-rw-r--r-- | FS/FS/cust_pay_void.pm | 2 | ||||
-rw-r--r-- | FS/FS/cust_payby.pm | 4 | ||||
-rw-r--r-- | FS/FS/cust_pkg.pm | 10 | ||||
-rw-r--r-- | FS/FS/cust_tax_exempt_pkg.pm | 2 | ||||
-rw-r--r-- | FS/FS/hardware_type.pm | 2 | ||||
-rw-r--r-- | FS/FS/inventory_item.pm | 2 | ||||
-rw-r--r-- | FS/FS/legacy_cust_bill.pm | 2 | ||||
-rw-r--r-- | FS/FS/legacy_cust_history.pm | 2 | ||||
-rw-r--r-- | FS/FS/part_event.pm | 2 | ||||
-rw-r--r-- | FS/FS/part_pkg.pm | 6 | ||||
-rw-r--r-- | FS/FS/part_svc.pm | 2 | ||||
-rw-r--r-- | FS/FS/radius_usergroup.pm | 2 | ||||
-rw-r--r-- | FS/FS/sales.pm | 2 | ||||
-rw-r--r-- | FS/FS/svc_Parent_Mixin.pm | 2 | ||||
-rw-r--r-- | FS/FS/svc_acct.pm | 2 | ||||
-rw-r--r-- | FS/FS/type_pkgs.pm | 2 |
29 files changed, 58 insertions, 44 deletions
diff --git a/FS/FS/ClientAPI.pm b/FS/FS/ClientAPI.pm index 1fea28c..2a88068 100644 --- a/FS/FS/ClientAPI.pm +++ b/FS/FS/ClientAPI.pm @@ -11,6 +11,16 @@ $me = '[FS::ClientAPI]'; %handler = (); +=head1 NAME + +FS::ClientAPI + +=item load_clientapi_modules + +=cut + +=cut + sub load_clientapi_modules { #find modules @@ -31,6 +41,10 @@ sub load_clientapi_modules { } +=item dispatch [ name ] + +=cut + sub dispatch { my ( $self, $name ) = ( shift, shift ); $name =~ s(/)(::)g; diff --git a/FS/FS/Cron/upload.pm b/FS/FS/Cron/upload.pm index 6a4d153..691170a 100644 --- a/FS/FS/Cron/upload.pm +++ b/FS/FS/Cron/upload.pm @@ -474,7 +474,7 @@ sub spool_upload { Retrieves the config value named CONFIG, parses it as a Text::Template, extracts "to" and "subject" headers, and returns a hash that can be passed -to L<FS::Misc::send_email>. +to L<FS::Misc/send_email>. PARAMS is a hashref to be passed to C<fill_in>. It must contain 'agentnum' to look up the per-agent config. diff --git a/FS/FS/PagedSearch.pm b/FS/FS/PagedSearch.pm index e740965..a1cd068 100644 --- a/FS/FS/PagedSearch.pm +++ b/FS/FS/PagedSearch.pm @@ -31,7 +31,7 @@ while ( my $row = $search->fetch ) { =item psearch ARGUMENTS -A wrapper around L<FS::Record::qsearch>. Accepts all the same arguments +A wrapper around L<FS::Record/qsearch>. Accepts all the same arguments as qsearch, except for the arrayref union query mode, and returns an FS::PagedSearch object to access the rows of the query one at a time. If the query doesn't contain an ORDER BY clause already, it will be ordered diff --git a/FS/FS/Template_Mixin.pm b/FS/FS/Template_Mixin.pm index c6a9b9f..953c6e1 100644 --- a/FS/FS/Template_Mixin.pm +++ b/FS/FS/Template_Mixin.pm @@ -2194,7 +2194,7 @@ notice name instead of "Invoice", optional =back -Returns an argument list to be passed to L<FS::Misc::send_email>. +Returns an argument list to be passed to L<FS::Misc/send_email>. =cut diff --git a/FS/FS/UI/Web.pm b/FS/FS/UI/Web.pm index 8a1d502..9b1c16f 100644 --- a/FS/FS/UI/Web.pm +++ b/FS/FS/UI/Web.pm @@ -471,9 +471,9 @@ sub cust_sql_fields { =item join_cust_main [ TABLE[.CUSTNUM] ] [ LOCATION_TABLE[.LOCATIONNUM] ] Returns an SQL join phrase for the FROM clause so that the fields listed -in L<cust_sql_fields> will be available. Currently joins to cust_main +in L</cust_sql_fields> will be available. Currently joins to cust_main itself, as well as cust_location (under the aliases 'bill_location' and -'ship_location') if address fields are needed. L<cust_header()> should have +'ship_location') if address fields are needed. L</cust_header> should have been called already. All of these will be left joins; if you want to exclude rows with no linked diff --git a/FS/FS/cust_bill.pm b/FS/FS/cust_bill.pm index 7158cb2..459206b 100644 --- a/FS/FS/cust_bill.pm +++ b/FS/FS/cust_bill.pm @@ -891,7 +891,7 @@ sub owed { Returns the amount to be displayed as the "Balance Due" on this invoice. Amount returned depends on conf flags for invoicing -See L<FS::cust_bill::owed> for the true amount currently owed +See L<FS::cust_bill/owed> for the true amount currently owed =cut @@ -1372,7 +1372,7 @@ sub ftp_invoice { =item spool_invoice [ TEMPLATENAME ] -Spools this invoice data (see L<FS::spool_csv>) +Spools this invoice data (see L<FS::cust_bill/spool_csv>) TEMPLATENAME is unused? @@ -3830,7 +3830,7 @@ The delete method. =head1 SEE ALSO L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>, -L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base +L<FS::cust_bill_pkg>, L<FS::cust_credit>, schema.html from the base documentation. =cut diff --git a/FS/FS/cust_bill_pkg_void.pm b/FS/FS/cust_bill_pkg_void.pm index 2cbfa02..883869b 100644 --- a/FS/FS/cust_bill_pkg_void.pm +++ b/FS/FS/cust_bill_pkg_void.pm @@ -115,7 +115,7 @@ freeform string (deprecated) =item reasonnum -reason for voiding the payment (see L<FS::reson>) +reason for voiding the payment (see L<FS::reason>) =back diff --git a/FS/FS/cust_bill_void.pm b/FS/FS/cust_bill_void.pm index 43b2950..60abc73 100644 --- a/FS/FS/cust_bill_void.pm +++ b/FS/FS/cust_bill_void.pm @@ -93,7 +93,7 @@ freeform string (deprecated) =item reasonnum -reason for voiding the payment (see L<FS::reson>) +reason for voiding the payment (see L<FS::reason>) =item void_usernum @@ -292,7 +292,7 @@ sub cust_pkg { Class method which returns an SQL WHERE fragment to search for parameters specified in HASHREF. Accepts the following parameters for -L<FS::cust_bill::search_sql_where>: C<_date>, C<invnum_min>, C<invnum_max>, +L<FS::cust_bill/search_sql_where>: C<_date>, C<invnum_min>, C<invnum_max>, C<agentnum>, C<custnum>, C<cust_classnum>, C<refnum>. Also accepts the following: diff --git a/FS/FS/cust_credit.pm b/FS/FS/cust_credit.pm index ddf407b..ad888f9 100644 --- a/FS/FS/cust_credit.pm +++ b/FS/FS/cust_credit.pm @@ -140,12 +140,12 @@ Ooptions are passed as a list of keys and values. Available options: =item reason_type -L<FS::reason_type|Reason> type for newly-inserted reason +L<FS::reason_type> Reason type for newly-inserted reason =item cust_credit_source_bill_pkg An arrayref of -L<FS::cust_credit_source_bill_pkg|FS::cust_credit_source_bilL_pkg> objects. +L<FS::cust_credit_source_bill_pkg> objects. They will have their crednum set and will be inserted along with this credit. =back diff --git a/FS/FS/cust_credit_bill_pkg.pm b/FS/FS/cust_credit_bill_pkg.pm index 080a83a..b305958 100644 --- a/FS/FS/cust_credit_bill_pkg.pm +++ b/FS/FS/cust_credit_bill_pkg.pm @@ -37,7 +37,7 @@ The following fields are currently supported: =item creditbillpkgnum - primary key -=item creditbillnum - Credit application to the overall invoice (see L<FS::cust_credit::bill>) +=item creditbillnum - Credit application to the overall invoice (see L<FS::cust_credit_bill>) =item billpkgnum - Line item to which credit is applied (see L<FS::cust_bill_pkg>) diff --git a/FS/FS/cust_main.pm b/FS/FS/cust_main.pm index 8647c82..112c28d 100644 --- a/FS/FS/cust_main.pm +++ b/FS/FS/cust_main.pm @@ -272,7 +272,7 @@ Enable individual CDR spooling, empty or `Y' =item dundate -A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp +A suggestion to events (see L<FS::part_bill_event>) to delay until this unix timestamp =item squelch_cdr @@ -2179,7 +2179,7 @@ FS::cust_pkg::cancel() methods. =item quiet - can be set true to supress email cancellation notices. -=item reason - can be set to a cancellation reason (see L<FS:reason>), either a +=item reason - can be set to a cancellation reason (see L<FS::reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>) @@ -2730,7 +2730,7 @@ UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions. The empty string can be passed to disable that time constraint completely. -Accepts the same options as L<balance_date_sql>: +Accepts the same options as L</balance_date_sql>: =over 4 diff --git a/FS/FS/cust_main_Mixin.pm b/FS/FS/cust_main_Mixin.pm index c36b79a..e31a310 100644 --- a/FS/FS/cust_main_Mixin.pm +++ b/FS/FS/cust_main_Mixin.pm @@ -372,7 +372,7 @@ Queue job for status updates. Required. =item search -Hashref of params to the L<search()> method. Required. +Hashref of params to the L<FS::Record/search> method. Required. =item msgnum diff --git a/FS/FS/cust_pay_batch.pm b/FS/FS/cust_pay_batch.pm index 614c117..6e76b34 100644 --- a/FS/FS/cust_pay_batch.pm +++ b/FS/FS/cust_pay_batch.pm @@ -239,7 +239,7 @@ sub expmmyy { =item pay_batch -Returns the payment batch this payment belongs to (L<FS::pay_batch). +Returns the payment batch this payment belongs to (L<FS::pay_batch>). =cut @@ -479,8 +479,8 @@ sub process_unbatch_and_delete { =item unbatch_and_delete May only be called on a record with an empty status and an associated -L<pay_batch> with a status of 'O' (not yet in transit.) Deletes all associated -records from L<cust_bill_pay_batch> and then deletes this record. +L<FS::pay_batch> with a status of 'O' (not yet in transit.) Deletes all associated +records from L<FS::cust_bill_pay_batch> and then deletes this record. If there is an error, returns the error, otherwise returns false. =cut diff --git a/FS/FS/cust_pay_void.pm b/FS/FS/cust_pay_void.pm index 29540d1..ce4e7da 100644 --- a/FS/FS/cust_pay_void.pm +++ b/FS/FS/cust_pay_void.pm @@ -94,7 +94,7 @@ Desired pkgnum when using experimental package balances. =item reason - a freeform string (deprecated) -=item reasonnum - Reason for voiding the payment (see L<FS::reson>) +=item reasonnum - Reason for voiding the payment (see L<FS::reason>) =back diff --git a/FS/FS/cust_payby.pm b/FS/FS/cust_payby.pm index 4e9f04f..410d690 100644 --- a/FS/FS/cust_payby.pm +++ b/FS/FS/cust_payby.pm @@ -668,7 +668,7 @@ sub label { =item realtime_bop -Runs a L<realtime_bop|FS::cust_main::Billing_Realtime::realtime_bop> transaction on this card +Runs a L<FS::cust_main::Billing_Realtime/realtime_bop> transaction on this card =cut @@ -684,7 +684,7 @@ sub realtime_bop { =item tokenize -Runs a L<realtime_tokenize|FS::cust_main::Billing_Realtime::realtime_tokenize> transaction on this card +Runs a L<FS::cust_main::Billing_Realtime/realtime_tokenize> transaction on this card =cut diff --git a/FS/FS/cust_pkg.pm b/FS/FS/cust_pkg.pm index d39dbbb..ba5016e 100644 --- a/FS/FS/cust_pkg.pm +++ b/FS/FS/cust_pkg.pm @@ -147,7 +147,7 @@ Billing item definition (see L<FS::part_pkg>) =item locationnum -Optional link to package location (see L<FS::location>) +Optional link to package location (see L<FS::cust_location>) =item order_date @@ -623,7 +623,7 @@ Available options are: =item reason -can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason. +can be set to a cancellation reason (see L<FS::reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason. =item reason_otaker @@ -869,7 +869,7 @@ correctly. Note however that this is an immediate cancel and just changes the date. You are PROBABLY looking to expire the account instead of using this. -=item reason - can be set to a cancellation reason (see L<FS:reason>), +=item reason - can be set to a cancellation reason (see L<FS::reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason. @@ -1521,7 +1521,7 @@ Available options are: =over 4 -=item reason - can be set to a cancellation reason (see L<FS:reason>), +=item reason - can be set to a cancellation reason (see L<FS::reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: - typenum - Reason type (see L<FS::reason_type> @@ -4767,7 +4767,7 @@ Available options are: =item reason -can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason. +can be set to a cancellation reason (see L<FS::reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason. =item reason_otaker diff --git a/FS/FS/cust_tax_exempt_pkg.pm b/FS/FS/cust_tax_exempt_pkg.pm index 5057781..68b7724 100644 --- a/FS/FS/cust_tax_exempt_pkg.pm +++ b/FS/FS/cust_tax_exempt_pkg.pm @@ -62,7 +62,7 @@ may be the setup fee, the recurring fee, or the sum of those. (cust_main.tax = 'Y'). =item exempt_cust_taxname - flag indicating that the customer is exempt -from the tax with this name (see L<FS::cust_main_exemption). +from the tax with this name (see L<FS::cust_main_exemption>). =item exempt_setup, exempt_recur: flag indicating that the package's setup or recurring fee is not taxable (part_pkg.setuptax and part_pkg.recurtax). diff --git a/FS/FS/hardware_type.pm b/FS/FS/hardware_type.pm index 8547312..844ea13 100644 --- a/FS/FS/hardware_type.pm +++ b/FS/FS/hardware_type.pm @@ -25,7 +25,7 @@ FS::hardware_type - Object methods for hardware_type records =head1 DESCRIPTION An FS::hardware_type object represents a device type (a model name or -number) assignable as a hardware service (L<FS::svc_hardware)>). +number) assignable as a hardware service (L<FS::svc_hardware>). FS::hardware_type inherits from FS::Record. The following fields are currently supported: diff --git a/FS/FS/inventory_item.pm b/FS/FS/inventory_item.pm index eef8880..9a58a64 100644 --- a/FS/FS/inventory_item.pm +++ b/FS/FS/inventory_item.pm @@ -153,7 +153,7 @@ maybe batch_import should be a regular method in FS::inventory_class =head1 SEE ALSO -L<inventory_class>, L<cust_svc>, L<FS::Record>, schema.html from the base +L<FS::inventory_class>, L<FS::cust_svc>, L<FS::Record>, schema.html from the base documentation. =cut diff --git a/FS/FS/legacy_cust_bill.pm b/FS/FS/legacy_cust_bill.pm index 6b43c2f..38f9485 100644 --- a/FS/FS/legacy_cust_bill.pm +++ b/FS/FS/legacy_cust_bill.pm @@ -45,7 +45,7 @@ Invoice number or identifier from previous system =item custnum -Customer (see L<FS::cust_main) +Customer (see L<FS::cust_main>) =item _date diff --git a/FS/FS/legacy_cust_history.pm b/FS/FS/legacy_cust_history.pm index 9e14903..e214d72 100644 --- a/FS/FS/legacy_cust_history.pm +++ b/FS/FS/legacy_cust_history.pm @@ -37,7 +37,7 @@ primary key =item custnum -Customer (see L<FS::cust_main) +Customer (see L<FS::cust_main>) =item history_action diff --git a/FS/FS/part_event.pm b/FS/FS/part_event.pm index ba5b6d6..be89459 100644 --- a/FS/FS/part_event.pm +++ b/FS/FS/part_event.pm @@ -638,7 +638,7 @@ sub process_initialize { =head1 SEE ALSO L<FS::part_event_option>, L<FS::part_event_condition>, L<FS::cust_main>, -L<FS::cust_pkg>, L<FS::svc_acct>, L<FS::cust_bill>, L<FS::cust_bill_event>, +L<FS::cust_pkg>, L<FS::svc_acct>, L<FS::cust_bill>, L<FS::cust_event>, L<FS::Record>, schema.html from the base documentation. diff --git a/FS/FS/part_pkg.pm b/FS/FS/part_pkg.pm index 05cbf1b..f8720a9 100644 --- a/FS/FS/part_pkg.pm +++ b/FS/FS/part_pkg.pm @@ -1900,11 +1900,11 @@ Frequency override (for calc_recur) This option is filled in by the method rather than controlling its operation. It is an arrayref. Applicable discounts will be added to the arrayref, as -L<FS::cust_bill_pkg_discount|FS::cust_bill_pkg_discount records>. +L<FS::cust_bill_pkg_discount> records. =item real_pkgpart -For package add-ons, is the base L<FS::part_pkg|package definition>, otherwise +For package add-ons, is the base L<FS::part_pkg> package definition, otherwise no different than pkgpart. =item precommit_hooks @@ -1928,7 +1928,7 @@ plan option prorate_defer_bill). =back Note: Don't calculate prices when not actually billing the package. For that, -see the L</base_setup|base_setup> and L</base_recur|base_recur> methods. +see the L<FS::cust_pkg/base_setup> and L<FS::cust_pkg/base_recur> methods. =cut diff --git a/FS/FS/part_svc.pm b/FS/FS/part_svc.pm index b82996e..49854f7 100644 --- a/FS/FS/part_svc.pm +++ b/FS/FS/part_svc.pm @@ -57,7 +57,7 @@ FS::Record. The following fields are currently supported: =item svcdb - table used for this service. See L<FS::svc_acct>, L<FS::svc_domain>, and L<FS::svc_forward>, among others. -=item classnum - Optional service class (see L<FS::svc_class>) +=item classnum - Optional service class (see L<FS::part_svc_class>) =item disabled - Disabled flag, empty or `Y' diff --git a/FS/FS/radius_usergroup.pm b/FS/FS/radius_usergroup.pm index 9c78796..cf3cdfa 100644 --- a/FS/FS/radius_usergroup.pm +++ b/FS/FS/radius_usergroup.pm @@ -156,7 +156,7 @@ sub _upgrade_data { #class method =head1 SEE ALSO -L<svc_acct>, L<FS::radius_group>, L<FS::Record>, schema.html from the base documentation. +L<FS::svc_acct>, L<FS::radius_group>, L<FS::Record>, schema.html from the base documentation. =cut diff --git a/FS/FS/sales.pm b/FS/FS/sales.pm index 3140928..c1e075e 100644 --- a/FS/FS/sales.pm +++ b/FS/FS/sales.pm @@ -44,7 +44,7 @@ Name =item agentnum -Agent (see L<FS::agent) +Agent (see L<FS::agent>) =item disabled diff --git a/FS/FS/svc_Parent_Mixin.pm b/FS/FS/svc_Parent_Mixin.pm index 4501baf..a63921f 100644 --- a/FS/FS/svc_Parent_Mixin.pm +++ b/FS/FS/svc_Parent_Mixin.pm @@ -76,7 +76,7 @@ sub children_svc_x { This class provides a check subroutine which takes care of checking the parent_svcnum field. The svc_ class which uses it will call SUPER::check at the end of its own checks, and this class will call NEXT::check to pass -the check "up the chain" (see L<NEXT>). +the check "up the chain" (see L<perlfunc/next>). =cut diff --git a/FS/FS/svc_acct.pm b/FS/FS/svc_acct.pm index 32190b1..053f1e0 100644 --- a/FS/FS/svc_acct.pm +++ b/FS/FS/svc_acct.pm @@ -2294,7 +2294,7 @@ sub is_rechargable { =item seconds_since TIMESTAMP Returns the number of seconds this account has been online since TIMESTAMP, -according to the session monitor (see L<FS::Session>). +according to the session monitor (see L<FS::session>). TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion functions. diff --git a/FS/FS/type_pkgs.pm b/FS/FS/type_pkgs.pm index d06050e..8cc2345 100644 --- a/FS/FS/type_pkgs.pm +++ b/FS/FS/type_pkgs.pm @@ -102,7 +102,7 @@ Returns the FS::agent_type object associated with this record. =head1 SEE ALSO -L<FS::Record>, L<FS::agent_type>, L<FS::part_pkgs>, schema.html from the base +L<FS::Record>, L<FS::agent_type>, L<FS::part_pkg>, schema.html from the base documentation. =cut |