We launched new forums in March 2019—join us there. In a hurry for help with your website? Get Help Now!
    • 18397
    • 3,250 Posts
    Could anyone run the MODx API (/manager/includes/document.parser.class.inc.php) through PHPDocumentor for the community? I can’t seem to get it to work quite right on my server or on my command line. Thanks in advance.
      • 21255
      • 215 Posts
      Just thought about that and found this topic wink
      I’ll try it out the next days. (For the moment, http://www.phpdoc.org/ seems to be down.)

      BTW: Don’t you need special tags in comments to get the thing working properly?
        • 34162
        • 1 Posts
        I am having problem using phpdoc and phpdocument as well! That is why I have been using phpxref.

        Here is a link to the latest api doc for MODx 0.9.1
        http://www.ongetc.com/modxdoc/nav.html?index.html

        Thanks
          • 32241
          • 1,495 Posts
          Chanh, that’s cool, but with phpDoc, I believe you can control the output for the description and etc.

          So which one that we’re going to use?
            Wendy Novianto
            [font=Verdana]PT DJAMOER Technology Media
            [font=Verdana]Xituz Media
            • 22303 MODX Staff
            • 10,725 Posts
            I’ve got PHPDocumentor integrated with the Tattoo codebase already, and yes it does require special comment formatting and tags to work properly. Someone would need to go edit all the code with the proper code format. Not very practical I don’t think, but an effort that could be undertaken by someone with enough motivation none-the-less.
              • 34162
              • 1 Posts
              phpxref support phpdoc format standard and the great thing about phpxref it does not take down the machine just to create the doc unlike phpdoc or phpdocumentator.
                • 32241
                • 1,495 Posts
                How about using doxygen?
                  Wendy Novianto
                  [font=Verdana]PT DJAMOER Technology Media
                  [font=Verdana]Xituz Media
                  • 33175
                  • 711 Posts
                  Doxygen is a good project, very efficient. I used it few years ago.
                  The only thing which I have to reproach it, it is its configuration. I don’t find it very easy.

                  Personnally, I used PHPEdit to create websites and to generate the documentation. But PHPEdit use PHPdocumentator...
                    Sorry for my english. I'm french... My dictionary is near me, but it's only a dictionary !
                    • 22303 MODX Staff
                    • 10,725 Posts
                    Part of the new 1.0 core code will include a build system that include automatic generation of API documentation (and internal developer documentation) via PHPDocumentor. It’s the only acceptable API doc generator I’ve found for automating the process from a build script (using Phing), and it seems to do a great job of it. I’m using this already in the development of MODx 1.0 and a separate object-relational bridge project I’m working on that will power the core of this new MODx. I’ll make some previews of this documentation available soon.
                      • 33175
                      • 711 Posts
                      Only good news today smiley
                        Sorry for my english. I'm french... My dictionary is near me, but it's only a dictionary !