From 7aaa05d2a698ad16441172b2fa294989f76001d1 Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Wed, 4 Feb 2015 16:15:43 -0500 Subject: [PATCH] Remove boilerplate from the top of api example files The @file comment added no information and was detrimental to readability of examples in the api explorer. --- api/v3/examples/Activity/ContactRefCustomField.php | 6 ------ api/v3/examples/Activity/ContactRefCustomFieldGet.php | 6 ------ api/v3/examples/Activity/Create.php | 6 ------ api/v3/examples/Activity/DateTimeHigh.php | 6 ------ api/v3/examples/Activity/DateTimeLow.php | 6 ------ api/v3/examples/Activity/Delete.php | 6 ------ api/v3/examples/Activity/Get.php | 6 ------ api/v3/examples/Activity/GetTargetandAssignee.php | 6 ------ api/v3/examples/Activity/Getfields.php | 6 ------ api/v3/examples/Activity/ReturnAssigneeContact.php | 6 ------ api/v3/examples/ActivityContact/Create.php | 6 ------ api/v3/examples/ActivityContact/Delete.php | 6 ------ api/v3/examples/ActivityType/Create.php | 6 ------ api/v3/examples/ActivityType/Get.php | 6 ------ api/v3/examples/Address/AddressLike.php | 6 ------ api/v3/examples/Address/AddressParse.php | 6 ------ api/v3/examples/Address/AddressSort.php | 6 ------ api/v3/examples/Address/Create.php | 6 ------ api/v3/examples/Address/Delete.php | 6 ------ api/v3/examples/Address/Get.php | 6 ------ api/v3/examples/Batch/Create.php | 6 ------ api/v3/examples/Batch/Delete.php | 6 ------ api/v3/examples/Batch/Get.php | 6 ------ api/v3/examples/Batch/Update.php | 6 ------ api/v3/examples/Campaign/Create.php | 6 ------ api/v3/examples/Campaign/Delete.php | 6 ------ api/v3/examples/Campaign/Get.php | 6 ------ api/v3/examples/Case/Create.php | 6 ------ api/v3/examples/Constant/Get.php | 6 ------ api/v3/examples/Contact/APIChainedArray.php | 6 ------ api/v3/examples/Contact/APIChainedArrayFormats.php | 6 ------ api/v3/examples/Contact/APIChainedArrayMultipleCustom.php | 6 ------ .../Contact/APIChainedArrayValuesFromSiblingFunction.php | 6 ------ api/v3/examples/Contact/ChainTwoWebsites.php | 6 ------ api/v3/examples/Contact/ChainTwoWebsitesSyntax2.php | 6 ------ api/v3/examples/Contact/Create.php | 6 ------ api/v3/examples/Contact/CustomFieldGet.php | 6 ------ .../Contact/CustomFieldGetReturnSyntaxVariation.php | 6 ------ api/v3/examples/Contact/Delete.php | 6 ------ api/v3/examples/Contact/FormatIsSuccess_Fail.php | 6 ------ api/v3/examples/Contact/FormatIsSuccess_True.php | 6 ------ api/v3/examples/Contact/FormatOnlyID.php | 6 ------ api/v3/examples/Contact/FormatSingleValue.php | 6 ------ api/v3/examples/Contact/Get.php | 6 ------ api/v3/examples/Contact/GetActions.php | 6 ------ api/v3/examples/Contact/GetCountContact.php | 6 ------ api/v3/examples/Contact/GetFieldsOptions.php | 6 ------ api/v3/examples/Contact/GetSingleContact.php | 6 ------ api/v3/examples/Contact/Getoptions.php | 6 ------ api/v3/examples/Contact/GroupFilterUsingContactAPI.php | 6 ------ .../Contribution/ContributionCreateWithHonoreeContact.php | 6 ------ .../examples/Contribution/ContributionCreateWithNote.php | 6 ------ .../Contribution/ContributionCreateWithSoftCredit.php | 6 ------ .../ContributionCreateWithSoftCreditDefaults.php | 6 ------ api/v3/examples/Contribution/Create.php | 6 ------ .../examples/Contribution/CreateWithNestedLineItems.php | 6 ------ api/v3/examples/Contribution/Delete.php | 6 ------ api/v3/examples/Contribution/Get.php | 6 ------ api/v3/examples/ContributionPage/Create.php | 6 ------ api/v3/examples/ContributionPage/Delete.php | 6 ------ api/v3/examples/ContributionPage/Get.php | 6 ------ api/v3/examples/ContributionPage/Submit.php | 6 ------ api/v3/examples/ContributionRecur/Create.php | 6 ------ api/v3/examples/ContributionRecur/Delete.php | 6 ------ api/v3/examples/ContributionRecur/Get.php | 6 ------ api/v3/examples/ContributionSoft/Create.php | 6 ------ api/v3/examples/ContributionSoft/Delete.php | 6 ------ api/v3/examples/ContributionSoft/Get.php | 6 ------ api/v3/examples/Country/Create.php | 6 ------ api/v3/examples/Country/Delete.php | 6 ------ api/v3/examples/Country/Get.php | 6 ------ api/v3/examples/CustomField/Create.php | 6 ------ api/v3/examples/CustomField/Delete.php | 6 ------ api/v3/examples/CustomGroup/Create.php | 6 ------ api/v3/examples/CustomGroup/Delete.php | 6 ------ api/v3/examples/CustomGroup/Get.php | 6 ------ api/v3/examples/CustomValue/Create.php | 6 ------ api/v3/examples/CustomValue/Get.php | 6 ------ api/v3/examples/CustomValue/formatFieldName.php | 6 ------ api/v3/examples/Domain/Create.php | 6 ------ api/v3/examples/Domain/Get.php | 6 ------ api/v3/examples/Email/Create.php | 6 ------ api/v3/examples/Email/Delete.php | 6 ------ api/v3/examples/Email/NestedReplaceEmail.php | 6 ------ api/v3/examples/Email/Replace.php | 6 ------ api/v3/examples/EntityTag/Create.php | 6 ------ api/v3/examples/EntityTag/Delete.php | 6 ------ api/v3/examples/EntityTag/Get.php | 6 ------ api/v3/examples/Event/Create.php | 6 ------ api/v3/examples/Event/Delete.php | 6 ------ api/v3/examples/Event/Get.php | 6 ------ api/v3/examples/Event/IsCurrentOption.php | 6 ------ api/v3/examples/Event/IsFullOption.php | 6 ------ api/v3/examples/Grant/Create.php | 6 ------ api/v3/examples/Grant/Delete.php | 6 ------ api/v3/examples/Grant/Get.php | 6 ------ api/v3/examples/Group/Get.php | 6 ------ api/v3/examples/Group/getfields.php | 6 ------ api/v3/examples/GroupContact/Create.php | 6 ------ api/v3/examples/GroupContact/Delete.php | 6 ------ api/v3/examples/GroupContact/Get.php | 6 ------ api/v3/examples/GroupContact/GetWithGroupID.php | 6 ------ api/v3/examples/GroupNesting/Create.php | 6 ------ api/v3/examples/GroupNesting/Delete.php | 6 ------ api/v3/examples/GroupNesting/Get.php | 6 ------ api/v3/examples/GroupOrganization/Create.php | 6 ------ api/v3/examples/GroupOrganization/Delete.php | 6 ------ api/v3/examples/GroupOrganization/Get.php | 6 ------ api/v3/examples/Im/Create.php | 6 ------ api/v3/examples/Im/Delete.php | 6 ------ api/v3/examples/Im/Get.php | 6 ------ api/v3/examples/Job/Create.php | 6 ------ api/v3/examples/Job/Delete.php | 6 ------ api/v3/examples/LineItem/Create.php | 6 ------ api/v3/examples/LineItem/Delete.php | 6 ------ api/v3/examples/LineItem/Get.php | 6 ------ api/v3/examples/LocBlock/createEntities.php | 6 ------ api/v3/examples/LocBlock/getEntities.php | 6 ------ api/v3/examples/LocBlock/simpleCreate.php | 6 ------ api/v3/examples/MailSettings/ChainedGetDelete.php | 6 ------ api/v3/examples/MailSettings/Create.php | 6 ------ api/v3/examples/MailSettings/Delete.php | 6 ------ api/v3/examples/MailSettings/Get.php | 6 ------ api/v3/examples/Mailing/Create.php | 6 ------ api/v3/examples/Mailing/Delete.php | 6 ------ api/v3/examples/Mailing/Submit.php | 6 ------ api/v3/examples/MailingGroup/Subscribe.php | 6 ------ api/v3/examples/Membership/Create.php | 6 ------ api/v3/examples/Membership/Delete.php | 6 ------ api/v3/examples/Membership/Get.php | 6 ------ api/v3/examples/Membership/Update.php | 6 ------ api/v3/examples/Membership/filterIsCurrent.php | 6 ------ api/v3/examples/MembershipPayment/Create.php | 6 ------ api/v3/examples/MembershipPayment/Get.php | 6 ------ api/v3/examples/MembershipStatus/Create.php | 6 ------ api/v3/examples/MembershipStatus/Get.php | 6 ------ api/v3/examples/MembershipType/Create.php | 6 ------ api/v3/examples/MembershipType/Delete.php | 6 ------ api/v3/examples/MembershipType/Get.php | 6 ------ api/v3/examples/MessageTemplate/Create.php | 6 ------ api/v3/examples/MessageTemplate/Delete.php | 6 ------ api/v3/examples/MessageTemplate/Get.php | 6 ------ api/v3/examples/Note/Create.php | 6 ------ api/v3/examples/Note/Delete.php | 6 ------ api/v3/examples/Note/Get.php | 6 ------ api/v3/examples/OptionGroup/Create.php | 6 ------ api/v3/examples/OptionGroup/Delete.php | 6 ------ api/v3/examples/OptionGroup/Get.php | 6 ------ api/v3/examples/OptionValue/Get.php | 6 ------ api/v3/examples/OptionValue/SortOption.php | 6 ------ api/v3/examples/Participant/Create.php | 6 ------ api/v3/examples/Participant/CreateParticipantPayment.php | 6 ------ api/v3/examples/Participant/Get.php | 6 ------ api/v3/examples/Participant/NestedDelete.php | 6 ------ api/v3/examples/Participant/NestedEventGet.php | 6 ------ api/v3/examples/ParticipantPayment/Create.php | 6 ------ api/v3/examples/ParticipantPayment/Delete.php | 6 ------ api/v3/examples/ParticipantPayment/Get.php | 6 ------ api/v3/examples/ParticipantStatusType/Create.php | 6 ------ api/v3/examples/ParticipantStatusType/Delete.php | 6 ------ api/v3/examples/ParticipantStatusType/Get.php | 6 ------ api/v3/examples/PaymentProcessor/Create.php | 6 ------ api/v3/examples/PaymentProcessor/Delete.php | 6 ------ api/v3/examples/PaymentProcessorType/Create.php | 6 ------ api/v3/examples/PaymentProcessorType/Delete.php | 6 ------ api/v3/examples/Phone/Create.php | 6 ------ api/v3/examples/Phone/Delete.php | 6 ------ api/v3/examples/Phone/Get.php | 6 ------ api/v3/examples/Pledge/Create.php | 6 ------ api/v3/examples/Pledge/Delete.php | 6 ------ api/v3/examples/Pledge/Get.php | 6 ------ api/v3/examples/Pledge/GetFilterHighDate.php | 6 ------ api/v3/examples/PledgePayment/Create.php | 6 ------ api/v3/examples/PledgePayment/Delete.php | 6 ------ api/v3/examples/PledgePayment/Get.php | 6 ------ api/v3/examples/PledgePayment/Update.php | 6 ------ api/v3/examples/PriceField/Create.php | 6 ------ api/v3/examples/PriceField/Delete.php | 6 ------ api/v3/examples/PriceField/Get.php | 6 ------ api/v3/examples/PriceFieldValue/Create.php | 6 ------ api/v3/examples/PriceFieldValue/Delete.php | 6 ------ api/v3/examples/PriceFieldValue/Get.php | 6 ------ api/v3/examples/PriceSet/Create.php | 6 ------ api/v3/examples/PriceSet/Delete.php | 6 ------ api/v3/examples/PriceSet/Get.php | 6 ------ api/v3/examples/Profile/Apply.php | 6 ------ api/v3/examples/Profile/Get.php | 6 ------ api/v3/examples/Profile/GetFields.php | 6 ------ api/v3/examples/Profile/Submit.php | 6 ------ api/v3/examples/Relationship/BetweenRelationshipType.php | 6 ------ api/v3/examples/Relationship/Create.php | 6 ------ api/v3/examples/Relationship/Delete.php | 6 ------ api/v3/examples/Relationship/Get.php | 6 ------ api/v3/examples/Relationship/INRelationshipType.php | 6 ------ .../examples/Relationship/NotBetweenRelationshipType.php | 6 ------ api/v3/examples/Relationship/NotInRelationshipType.php | 6 ------ api/v3/examples/Relationship/filterIsCurrent.php | 6 ------ api/v3/examples/RelationshipType/Create.php | 6 ------ api/v3/examples/RelationshipType/Delete.php | 6 ------ api/v3/examples/ReportTemplate/Getrows.php | 6 ------ api/v3/examples/ReportTemplate/Getstatistics.php | 6 ------ api/v3/examples/Setting/Create.php | 6 ------ api/v3/examples/Setting/CreateAllDomains.php | 6 ------ api/v3/examples/Setting/CreateSettingCurrentDomain.php | 6 ------ api/v3/examples/Setting/CreateSpecifiedDomains.php | 6 ------ api/v3/examples/Setting/Get.php | 6 ------ api/v3/examples/Setting/GetAllDomains.php | 6 ------ api/v3/examples/Setting/GetDefaults.php | 6 ------ api/v3/examples/Setting/GetFields.php | 6 ------ api/v3/examples/Setting/GetSettingCurrentDomain.php | 6 ------ api/v3/examples/Setting/GetSpecifiedDomains.php | 6 ------ api/v3/examples/Setting/GetValue.php | 6 ------ api/v3/examples/Setting/Revert.php | 6 ------ api/v3/examples/Survey/ChainedGetDelete.php | 6 ------ api/v3/examples/Survey/Create.php | 6 ------ api/v3/examples/Survey/Delete.php | 6 ------ api/v3/examples/Survey/Get.php | 6 ------ api/v3/examples/SurveyRespondant/Get.php | 6 ------ api/v3/examples/System/Flush.php | 6 ------ api/v3/examples/Tag/Create.php | 6 ------ api/v3/examples/Tag/Delete.php | 6 ------ api/v3/examples/Tag/Get.php | 6 ------ api/v3/examples/Tag/GetList.php | 6 ------ api/v3/examples/Tag/Getfields.php | 6 ------ api/v3/examples/Tag/getReturnArray.php | 6 ------ api/v3/examples/TaxContributionPage/Create.php | 6 ------ .../TaxContributionPage/CreateWithNestedLineItems.php | 6 ------ api/v3/examples/TaxContributionPage/Delete.php | 6 ------ api/v3/examples/UFField/Create.php | 6 ------ api/v3/examples/UFField/Delete.php | 6 ------ api/v3/examples/UFField/Get.php | 6 ------ api/v3/examples/UFField/Replace.php | 6 ------ api/v3/examples/UFGroup/Create.php | 6 ------ api/v3/examples/UFGroup/Delete.php | 6 ------ api/v3/examples/UFGroup/Get.php | 6 ------ api/v3/examples/UFJoin/Create.php | 6 ------ api/v3/examples/UFJoin/Get.php | 6 ------ api/v3/examples/UFMatch/Get.php | 6 ------ api/v3/examples/Website/Create.php | 6 ------ api/v3/examples/Website/Delete.php | 6 ------ api/v3/examples/Website/Get.php | 6 ------ api/v3/examples/Website/GetFields.php | 6 ------ api/v3/examples/Website/GetWithMetadata.php | 6 ------ tests/templates/documentFunction.tpl | 8 +------- 244 files changed, 1 insertion(+), 1465 deletions(-) diff --git a/api/v3/examples/Activity/ContactRefCustomField.php b/api/v3/examples/Activity/ContactRefCustomField.php index 1140538e09..0f056fa0f6 100644 --- a/api/v3/examples/Activity/ContactRefCustomField.php +++ b/api/v3/examples/Activity/ContactRefCustomField.php @@ -1,10 +1,4 @@