Uploaded image for project: 'Community Platforms'
  1. Community Platforms
  2. COM-18884

Source Code Documentation Missing and Not Publicly Displayed!

    XMLWordPrintable

Details

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: Medium Medium
    • None
    • None
    • Community
    • None
    • N/A

    Description

      Hello,

      I was using pubsvn.ez.no api documentation today and realized that the source code documentation listed as available is out of date and incomplete. Specifically ...

      ==== First Item of Concern ====

      While the 4.5 directory is available at [0] it is not listed (at all) on the home page [1]

      This is confusing to users who do not know what is available until they are shown on the home page that these api documentation resources are actually available.

      Please update the home page [1] to show that 4.5 api documentation is available.

      [0] http://pubsvn.ez.no/doxygen/4.5/html/
      [1] http://pubsvn.ez.no

      ==== Second Item of Concern ====

      Also I noted that a documentation file [6] which was previously available (in doxygen generated for eZ Publish, a file doc which I actually used) is no longer available [2][3][4] Note: While these links [2][3][4] are invalid now, the really did used to function correctly.

      Could you find out why the documentation for this file [6] is no longer being generated?

      [2] http://pubsvn.ez.no/doxygen/trunk/html/version_8php_source.html
      [3] http://pubsvn.ez.no/doxygen/4.4/html/version_8php_source.html
      [4] http://pubsvn.ez.no/doxygen/4.3/html/version_8php_source.html
      [6] https://github.com/ezsystems/ezpublish/blob/master/lib/version.php

      I actually made reference to this file long ago in another issue [5] to point out that the api documentation was not being updated any longer. Now that this file is missing I can no longer tell what version of the generated documentation is specifically generated. The class name specifically missing from the generated documentation is 'eZPublishSDK'.

      [5] http://issues.ez.no/17442

      I also tried to search for this class [7] to find that not only did it not appear in the search results, I noticed within code which makes reference/use of this class (which normally would auto link to the class method being used) this class is no longer autolinked to (perhapse because the eZPublishSDK documentation is no longer being generated properly)!

      [7]
      http://pubsvn.ez.no/doxygen/trunk/html/search.php?query=eZPublishSDK

      *I think both of these items are critical breakdowns for the community. Please respond ...*

      Thank you for your continued support.

      Cheers,
      Heath

      Steps to reproduce

      N/A

      Attachments

        Activity

          People

            72f8acac-185f-4a54-9470-a7473f50daab@accounts.ibexa.co Gaetano Giunta
            bc.heath bc.heath
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: