Remove boilerplate from the top of api example files
authorColeman Watts <coleman@civicrm.org>
Wed, 4 Feb 2015 21:15:43 +0000 (16:15 -0500)
committerColeman Watts <coleman@civicrm.org>
Wed, 4 Feb 2015 21:15:43 +0000 (16:15 -0500)
commit7aaa05d2a698ad16441172b2fa294989f76001d1
tree76c0343c97b3a8b31f34d311bbc5cfdb8f0b1fc3
parent7e7558fcab74258ebdda7887241c2efa5525b0bd
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.
244 files changed:
api/v3/examples/Activity/ContactRefCustomField.php
api/v3/examples/Activity/ContactRefCustomFieldGet.php
api/v3/examples/Activity/Create.php
api/v3/examples/Activity/DateTimeHigh.php
api/v3/examples/Activity/DateTimeLow.php
api/v3/examples/Activity/Delete.php
api/v3/examples/Activity/Get.php
api/v3/examples/Activity/GetTargetandAssignee.php
api/v3/examples/Activity/Getfields.php
api/v3/examples/Activity/ReturnAssigneeContact.php
api/v3/examples/ActivityContact/Create.php
api/v3/examples/ActivityContact/Delete.php
api/v3/examples/ActivityType/Create.php
api/v3/examples/ActivityType/Get.php
api/v3/examples/Address/AddressLike.php
api/v3/examples/Address/AddressParse.php
api/v3/examples/Address/AddressSort.php
api/v3/examples/Address/Create.php
api/v3/examples/Address/Delete.php
api/v3/examples/Address/Get.php
api/v3/examples/Batch/Create.php
api/v3/examples/Batch/Delete.php
api/v3/examples/Batch/Get.php
api/v3/examples/Batch/Update.php
api/v3/examples/Campaign/Create.php
api/v3/examples/Campaign/Delete.php
api/v3/examples/Campaign/Get.php
api/v3/examples/Case/Create.php
api/v3/examples/Constant/Get.php
api/v3/examples/Contact/APIChainedArray.php
api/v3/examples/Contact/APIChainedArrayFormats.php
api/v3/examples/Contact/APIChainedArrayMultipleCustom.php
api/v3/examples/Contact/APIChainedArrayValuesFromSiblingFunction.php
api/v3/examples/Contact/ChainTwoWebsites.php
api/v3/examples/Contact/ChainTwoWebsitesSyntax2.php
api/v3/examples/Contact/Create.php
api/v3/examples/Contact/CustomFieldGet.php
api/v3/examples/Contact/CustomFieldGetReturnSyntaxVariation.php
api/v3/examples/Contact/Delete.php
api/v3/examples/Contact/FormatIsSuccess_Fail.php
api/v3/examples/Contact/FormatIsSuccess_True.php
api/v3/examples/Contact/FormatOnlyID.php
api/v3/examples/Contact/FormatSingleValue.php
api/v3/examples/Contact/Get.php
api/v3/examples/Contact/GetActions.php
api/v3/examples/Contact/GetCountContact.php
api/v3/examples/Contact/GetFieldsOptions.php
api/v3/examples/Contact/GetSingleContact.php
api/v3/examples/Contact/Getoptions.php
api/v3/examples/Contact/GroupFilterUsingContactAPI.php
api/v3/examples/Contribution/ContributionCreateWithHonoreeContact.php
api/v3/examples/Contribution/ContributionCreateWithNote.php
api/v3/examples/Contribution/ContributionCreateWithSoftCredit.php
api/v3/examples/Contribution/ContributionCreateWithSoftCreditDefaults.php
api/v3/examples/Contribution/Create.php
api/v3/examples/Contribution/CreateWithNestedLineItems.php
api/v3/examples/Contribution/Delete.php
api/v3/examples/Contribution/Get.php
api/v3/examples/ContributionPage/Create.php
api/v3/examples/ContributionPage/Delete.php
api/v3/examples/ContributionPage/Get.php
api/v3/examples/ContributionPage/Submit.php
api/v3/examples/ContributionRecur/Create.php
api/v3/examples/ContributionRecur/Delete.php
api/v3/examples/ContributionRecur/Get.php
api/v3/examples/ContributionSoft/Create.php
api/v3/examples/ContributionSoft/Delete.php
api/v3/examples/ContributionSoft/Get.php
api/v3/examples/Country/Create.php
api/v3/examples/Country/Delete.php
api/v3/examples/Country/Get.php
api/v3/examples/CustomField/Create.php
api/v3/examples/CustomField/Delete.php
api/v3/examples/CustomGroup/Create.php
api/v3/examples/CustomGroup/Delete.php
api/v3/examples/CustomGroup/Get.php
api/v3/examples/CustomValue/Create.php
api/v3/examples/CustomValue/Get.php
api/v3/examples/CustomValue/formatFieldName.php
api/v3/examples/Domain/Create.php
api/v3/examples/Domain/Get.php
api/v3/examples/Email/Create.php
api/v3/examples/Email/Delete.php
api/v3/examples/Email/NestedReplaceEmail.php
api/v3/examples/Email/Replace.php
api/v3/examples/EntityTag/Create.php
api/v3/examples/EntityTag/Delete.php
api/v3/examples/EntityTag/Get.php
api/v3/examples/Event/Create.php
api/v3/examples/Event/Delete.php
api/v3/examples/Event/Get.php
api/v3/examples/Event/IsCurrentOption.php
api/v3/examples/Event/IsFullOption.php
api/v3/examples/Grant/Create.php
api/v3/examples/Grant/Delete.php
api/v3/examples/Grant/Get.php
api/v3/examples/Group/Get.php
api/v3/examples/Group/getfields.php
api/v3/examples/GroupContact/Create.php
api/v3/examples/GroupContact/Delete.php
api/v3/examples/GroupContact/Get.php
api/v3/examples/GroupContact/GetWithGroupID.php
api/v3/examples/GroupNesting/Create.php
api/v3/examples/GroupNesting/Delete.php
api/v3/examples/GroupNesting/Get.php
api/v3/examples/GroupOrganization/Create.php
api/v3/examples/GroupOrganization/Delete.php
api/v3/examples/GroupOrganization/Get.php
api/v3/examples/Im/Create.php
api/v3/examples/Im/Delete.php
api/v3/examples/Im/Get.php
api/v3/examples/Job/Create.php
api/v3/examples/Job/Delete.php
api/v3/examples/LineItem/Create.php
api/v3/examples/LineItem/Delete.php
api/v3/examples/LineItem/Get.php
api/v3/examples/LocBlock/createEntities.php
api/v3/examples/LocBlock/getEntities.php
api/v3/examples/LocBlock/simpleCreate.php
api/v3/examples/MailSettings/ChainedGetDelete.php
api/v3/examples/MailSettings/Create.php
api/v3/examples/MailSettings/Delete.php
api/v3/examples/MailSettings/Get.php
api/v3/examples/Mailing/Create.php
api/v3/examples/Mailing/Delete.php
api/v3/examples/Mailing/Submit.php
api/v3/examples/MailingGroup/Subscribe.php
api/v3/examples/Membership/Create.php
api/v3/examples/Membership/Delete.php
api/v3/examples/Membership/Get.php
api/v3/examples/Membership/Update.php
api/v3/examples/Membership/filterIsCurrent.php
api/v3/examples/MembershipPayment/Create.php
api/v3/examples/MembershipPayment/Get.php
api/v3/examples/MembershipStatus/Create.php
api/v3/examples/MembershipStatus/Get.php
api/v3/examples/MembershipType/Create.php
api/v3/examples/MembershipType/Delete.php
api/v3/examples/MembershipType/Get.php
api/v3/examples/MessageTemplate/Create.php
api/v3/examples/MessageTemplate/Delete.php
api/v3/examples/MessageTemplate/Get.php
api/v3/examples/Note/Create.php
api/v3/examples/Note/Delete.php
api/v3/examples/Note/Get.php
api/v3/examples/OptionGroup/Create.php
api/v3/examples/OptionGroup/Delete.php
api/v3/examples/OptionGroup/Get.php
api/v3/examples/OptionValue/Get.php
api/v3/examples/OptionValue/SortOption.php
api/v3/examples/Participant/Create.php
api/v3/examples/Participant/CreateParticipantPayment.php
api/v3/examples/Participant/Get.php
api/v3/examples/Participant/NestedDelete.php
api/v3/examples/Participant/NestedEventGet.php
api/v3/examples/ParticipantPayment/Create.php
api/v3/examples/ParticipantPayment/Delete.php
api/v3/examples/ParticipantPayment/Get.php
api/v3/examples/ParticipantStatusType/Create.php
api/v3/examples/ParticipantStatusType/Delete.php
api/v3/examples/ParticipantStatusType/Get.php
api/v3/examples/PaymentProcessor/Create.php
api/v3/examples/PaymentProcessor/Delete.php
api/v3/examples/PaymentProcessorType/Create.php
api/v3/examples/PaymentProcessorType/Delete.php
api/v3/examples/Phone/Create.php
api/v3/examples/Phone/Delete.php
api/v3/examples/Phone/Get.php
api/v3/examples/Pledge/Create.php
api/v3/examples/Pledge/Delete.php
api/v3/examples/Pledge/Get.php
api/v3/examples/Pledge/GetFilterHighDate.php
api/v3/examples/PledgePayment/Create.php
api/v3/examples/PledgePayment/Delete.php
api/v3/examples/PledgePayment/Get.php
api/v3/examples/PledgePayment/Update.php
api/v3/examples/PriceField/Create.php
api/v3/examples/PriceField/Delete.php
api/v3/examples/PriceField/Get.php
api/v3/examples/PriceFieldValue/Create.php
api/v3/examples/PriceFieldValue/Delete.php
api/v3/examples/PriceFieldValue/Get.php
api/v3/examples/PriceSet/Create.php
api/v3/examples/PriceSet/Delete.php
api/v3/examples/PriceSet/Get.php
api/v3/examples/Profile/Apply.php
api/v3/examples/Profile/Get.php
api/v3/examples/Profile/GetFields.php
api/v3/examples/Profile/Submit.php
api/v3/examples/Relationship/BetweenRelationshipType.php
api/v3/examples/Relationship/Create.php
api/v3/examples/Relationship/Delete.php
api/v3/examples/Relationship/Get.php
api/v3/examples/Relationship/INRelationshipType.php
api/v3/examples/Relationship/NotBetweenRelationshipType.php
api/v3/examples/Relationship/NotInRelationshipType.php
api/v3/examples/Relationship/filterIsCurrent.php
api/v3/examples/RelationshipType/Create.php
api/v3/examples/RelationshipType/Delete.php
api/v3/examples/ReportTemplate/Getrows.php
api/v3/examples/ReportTemplate/Getstatistics.php
api/v3/examples/Setting/Create.php
api/v3/examples/Setting/CreateAllDomains.php
api/v3/examples/Setting/CreateSettingCurrentDomain.php
api/v3/examples/Setting/CreateSpecifiedDomains.php
api/v3/examples/Setting/Get.php
api/v3/examples/Setting/GetAllDomains.php
api/v3/examples/Setting/GetDefaults.php
api/v3/examples/Setting/GetFields.php
api/v3/examples/Setting/GetSettingCurrentDomain.php
api/v3/examples/Setting/GetSpecifiedDomains.php
api/v3/examples/Setting/GetValue.php
api/v3/examples/Setting/Revert.php
api/v3/examples/Survey/ChainedGetDelete.php
api/v3/examples/Survey/Create.php
api/v3/examples/Survey/Delete.php
api/v3/examples/Survey/Get.php
api/v3/examples/SurveyRespondant/Get.php
api/v3/examples/System/Flush.php
api/v3/examples/Tag/Create.php
api/v3/examples/Tag/Delete.php
api/v3/examples/Tag/Get.php
api/v3/examples/Tag/GetList.php
api/v3/examples/Tag/Getfields.php
api/v3/examples/Tag/getReturnArray.php
api/v3/examples/TaxContributionPage/Create.php
api/v3/examples/TaxContributionPage/CreateWithNestedLineItems.php
api/v3/examples/TaxContributionPage/Delete.php
api/v3/examples/UFField/Create.php
api/v3/examples/UFField/Delete.php
api/v3/examples/UFField/Get.php
api/v3/examples/UFField/Replace.php
api/v3/examples/UFGroup/Create.php
api/v3/examples/UFGroup/Delete.php
api/v3/examples/UFGroup/Get.php
api/v3/examples/UFJoin/Create.php
api/v3/examples/UFJoin/Get.php
api/v3/examples/UFMatch/Get.php
api/v3/examples/Website/Create.php
api/v3/examples/Website/Delete.php
api/v3/examples/Website/Get.php
api/v3/examples/Website/GetFields.php
api/v3/examples/Website/GetWithMetadata.php
tests/templates/documentFunction.tpl