lib/cocoapods/generator/documentation.rb
def generate(install_docset)
        if `which appledoc`.strip.empty?
          UI.warn "[!] Skipping documentation generation because appledoc can't be found.",
            actions = [], verbose_only = true
          return
        end

        target_path.mkpath
        Dir.chdir(pod_root) do
          appledoc apple_doc_command_line_arguments(install_docset)
        end

        if $?.exitstatus != 0
          UI.warn "[!] Appledoc encountered an error (exitstatus: #{$?.exitstatus}), an update might be available to solve the issue."
        end

      end
# Generates and optionally installs the documentation for the current
# Pod.
#
# @param  [Bool] install_docset
#         Whether the documentation should also be installed in Xcode.
#
# @note   As the documentation is once per Pod to speed up the
#         installation process it is generate for all the specs
#         (including those not currently used). For this reason it is
#         important that the documentation is generated before cleaning a
#         Pod installation.
#
# @todo   Passing the files explicitly clutters output and chokes on very
#         long list (AWSiOSSDK).  It is possible to just pass the dir of
#         the pod, however this would include other files like demo
#         projects.
#
# @return [void]
#
Generates and optionally installs the documentation for the current
Pod.
Generates and optionally installs the documentation for the current Pod .
def generate(install_docset)
        if `which appledoc`.strip.empty?
          UI.warn "[!] Skipping documentation generation because appledoc can't be found.",
            actions = [], verbose_only = true
          return
        end
        target_path.mkpath
        Dir.chdir(pod_root) do
          appledoc apple_doc_command_line_arguments(install_docset)
        end
        if $?.exitstatus != 0
          UI.warn "[!] Appledoc encountered an error (exitstatus: #{$?.exitstatus}), an update might be available to solve the issue."
        end
      end
def generate ( install_docset ) if ` which appledoc ` . strip . empty? UI . warn "[!] Skipping documentation generation because appledoc can't be found." , actions = [ ] , verbose_only = true return end target_path . mkpath Dir . chdir ( pod_root ) do appledoc apple_doc_command_line_arguments ( install_docset ) end if $? . exitstatus != 0 UI . warn "[!] Appledoc encountered an error (exitstatus: #{$?.exitstatus}), an update might be available to solve the issue." end end
Generates and optionally installs the documentation for the current
Pod.
Generates and optionally installs the documentation for the current Pod .
None
void
install_docset
install_docset Whether the documentation should also be installed in Xcode.
install_docset Whether the documentation should also be installed in Xcode .
note
As the documentation is once per Pod to speed up the installation process it is generate for all the specs (including those not currently used). For this reason it is important that the documentation is generated before cleaning a Pod installation.
As the documentation is once per Pod to speed up the installation process it is generate for all the specs ( including those not currently used ) . For this reason it is important that the documentation is generated before cleaning a Pod installation .
todo
Passing the files explicitly clutters output and chokes on very long list (AWSiOSSDK). It is possible to just pass the dir of the pod, however this would include other files like demo projects.
Passing the files explicitly clutters output and chokes on very long list ( AWSiOSSDK ) . It is possible to just pass the dir of the pod however this would include other files like demo projects .