Search Results

Search found 48 results on 2 pages for 'phpdoc'.

Page 1/2 | 1 2  | Next Page >

  • can't find phpdoc binary?

    - by ajsie
    i've downloaded the phpdoc from their site, extracted it and put it in apache's documentroot for access through the web browser. however, i cant access the "phpdoc" tool from the command line. i have to add it to a Path but i cant find it in the extracted folder. where is it?

    Read the article

  • Can't find the PHPdoc binary file

    - by ajsie
    I've downloaded the phpdoc from their site, extracted it, and put it in apache's documentroot for access through the web browser. However, I cant access the phpdoc tool from the command line. I have to add it to the PATH because I want to use the command line for automated documentation building, but considering I can't find it I can't add it to the PATH.

    Read the article

  • PHPDoc Function Changelog (@change?)

    - by danilo
    What is the best way to document changes in a function with PHPDoc? Something like @change 2010.20.16 user added feature x @change 2010.20.26 user added feature y would be great. But assume there's no @change option... If i add it anyways, what will PHPDoc do with it? Or is there a better / more correct way to document function changes?

    Read the article

  • php / phpDoc - @return instance of $this class ?

    - by searbe
    How do I mark a method as "returns an instance of the current class" in my phpDoc? In the following example my IDE (Netbeans) will see that setSomething always returns a foo object. But that's not true if I extent the object - it'll return $this, which in the second example is a bar object not a foo object. class foo { protected $_value = null; /** * Set something * * @param string $value the value * @return foo */ public function setSomething($value) { $this->_value = $value; return $this; } } $foo = new foo(); $out = $foo->setSomething(); So fine - setSomething returns a foo - but in the following example, it returns a bar..: class bar extends foo { public function someOtherMethod(){} } $bar = new bar(); $out = $bar->setSomething(); $out->someOtherMethod(); // <-- Here, Netbeans will think $out // is a foo, so doesn't see this other // method in $out's code-completion ... it'd be great to solve this as for me, code completion is a massive speed-boost. Anyone got a clever trick, or even better, a proper way to document this with phpDoc?

    Read the article

  • What kind parser that phpdoc use ?

    - by justjoe
    When the first time, i install phpdoc, i love it so much. And i want to create its mini version for myself use. So, can anybody give me information about what kind of parser it has. and Maybe a image reference on how it works (so i can picture it visually in my mind) ?

    Read the article

  • Documenting PHP multiple inheritance with PhpDoc

    - by Sam Dark
    I have multiple inheritance like this one: http://stackoverflow.com/questions/356128/can-i-extend-a-class-using-more-than-1-class-in-php (let's not discuss this approach itself please) and want my IDE to know about inherited class methods and properties. Is there a way to do it with PhpDoc?

    Read the article

  • Regex to strip phpdoc multiline comment

    - by Reveller
    I have this: /** * @file * API for loading and interacting with modules. * More explaination here. * * @author Reveller <me@localhost> * @version 19:05 28-12-2008 */ I'm looking for a regex to strip all but the @token data, so the result would be: @file API for loading and interacting with modules. More explaination here. @author Reveller <me@localhost> @version 19:05 28-12-2008 I now have this: $text = preg_replace('/\r?\n *\* */', ' ', $text); It does the job partially: it only removes the * in front of each line. Who could help me so it also strips /** and the final slash /? Any help would be greatly appreciated! P.S: If, for instance, the commentlbock would contain something like /** * @foo Here's some slashes for ya: / and \ */ Then obviously the slashes after @foo may not be stripped. The reult would have to be: @foo Here's some slashes for ya: / and \ I hope there's a regex guru out there :-)

    Read the article

  • Is there a way to alter Zend Studio PhpDoc preferences?

    - by Tower
    Hi, I'm trying out Zend Studio trial and I have a few things on my mind related to PhpDoc. If I have the following code: public function sum($a, $b) { echo $a + $b; } and then I start typing /** in the front of the function and press Enter, Zend Studio automatically makes the following text: /** * [cursor] * @param unknown_type $a * @param unknown_type $b */ However, I want to customize this so that it also includes @return void automatically since there's no return inside the function. Is there a way to do this? And what about things like @access? It's obviously "public". Another thing I want is that when I create a new file and I use the code templates with ${user}, it will use my Windows account, but I want it to use something else - is there a way to specify this "user"?

    Read the article

  • How to document an accessor/mutator method in phpDoc/javaDoc?

    - by nickf
    Given a function which behaves as either a mutator or accessor depending on the arguments passed to it, like this: // in PHP, you can pass any number of arguments to a function... function cache($cacheName) { $arguments = func_get_args(); if (count($arguments) >= 2) { // two arguments passed. MUTATOR. $value = $arguments[1]; // use the second as the value $this->cache[$cacheName] = $value; // *change* the stored value } else { // 1 argument passed, ACCESSOR return $this->cache[$cacheName]; // *get* the stored value } } cache('foo', 'bar'); // nothing returned cache('foo') // 'bar' returned How do you document this in PHPDoc or a similar automated documentation creator? I had originally just written it like this: /** * Blah blah blah, you can use this as both a mutator and an accessor: * As an accessor: * @param $cacheName name of the variable to GET * @return string the value... * * As a mutator: * @param $cacheName name of the variable to SET * @param $value the value to set * @return void */ However, when this is run through phpDoc, it complains because there are 2 return tags, and the first @param $cacheName description is overwritten by the second. Is there a way around this?

    Read the article

  • How to parse phpDoc style comment block with php?

    - by Reveller
    Please consider the following code with which I'm trying to parse only the first phpDoc style comment (noy using any other libraries) in a file (file contents put in $data variable for testing purposes): $data = " /** * @file A lot of info about this file * Could even continue on the next line * @author [email protected] * @version 2010-05-01 * @todo do stuff... */ /** * Comment bij functie bar() * @param Array met dingen */ function bar($baz) { echo $baz; } "; $data = trim(preg_replace('/\r?\n *\* */', ' ', $data)); preg_match_all('/@([a-z]+)\s+(.*?)\s*(?=$|@[a-z]+\s)/s', $data, $matches); $info = array_combine($matches[1], $matches[2]); print_r($info) This almose works, except for the fact that everything after @todo (including the bar() comment block and code) is considered the value of @todo: Array ( [file] => A lot of info about this file Could even continue on the next line [author] => [email protected] [version] => 2010-05-01 [todo] => do stuff... / /** Comment bij functie bar() [param] => Array met dingen / function bar() { echo ; } ) How does my code need to be altered so that only the first comment block is being parsed (in other words: parsing should stop after the first "*/" encountered?

    Read the article

  • Is there a good (standalone) PHPDoc parser class or function in PHP?

    - by Kris
    Hi folks, I'm looking for some method of converting a PHP Docblock (as used for generating documentation by tools like Doxygen) into a structure I can inspect in PHP. For example, I want to parse the following lines: /** * Multiply two values * @CHECKME * * @author someone * @created eons ago * * @param integer $x * @param integer $x * * @return integer */ function multiply($x, $y) { return $x * $y; } Into something similar to: array( 'author' = 'someone' ,'created' = 'eons ago' ,'param' = array( 'integer $x' ,'integer $y' ) ,'_flags' = array( '@CHECKME' ) ); I explicitly cannot use PEAR or any such library, it has to be relatively standalone. Any given solution that is better than using a bunch of regexes after stripping away comment outline would be awesome.

    Read the article

  • PHP Doc software on OSX?

    - by NeoNmaN
    I use my OSX for dev. PHP and now i need to try PHPDoc but how? sombardy know a software? or how i can doe it? i try to look here http://manual.phpdoc.org/HTMLSmartyConverter/HandS/ric_INSTALL.html but i hobe i can found a GUI software the out. :) tanks for all help.

    Read the article

  • Can any body help to split php source code

    - by joe-on-wp
    hi, can any body help me on separating this example of data that i need to parse and seperate text just like PHPDoc. It is PHP source code. The example string : function one_to_tree() { //bla bla bla return FALSE; } function two_to_tree() { //bla bla bla return FALSE; } function three_to_tree() { if ($sample){ //bla bla bla } return FALSE; } can anybody help me how to seperate above string based on "function" word and create and array. Thank you

    Read the article

  • "No Suggestions" in NetBeans

    - by Flexx
    For a few days now I'm using NetBeans 6.8 for doing PHP work. But even if a class-file is included and the methods are public and there's phpDoc used, NetBeans everytime shows "No Suggestions" in the window. E.g. I type $user-> and press CTRL+Space, I do expect all the methods and variables but there aren't shown any. ideas?

    Read the article

  • documentation for a package in php?

    - by ajsie
    so in a folder PayPal i've got multiple classes for using their API. i want to make a documentation for how to use all the classes in a sequential way. so here is my questions: how do i create a package for them? cause above each class i used phpdoc tag @package PayPal. is a package in php just a folder? where do i put documentation for the package? there are best practices for this? a file in the folder named ...? how to put class- or package-specific examples, eg. step 1 bla bla, step 2 bla bla? thanks!

    Read the article

  • A tool to aid completion of missing or incomplete source code documentation

    - by Pekka
    I have several finished, older PHP projects with a lot of includes that I would like to document in javadoc/phpDocumentor style. While working through each file manually and being forced to do a code review alongside the documenting would be the best thing, I am, simply out of time constraints, interested in tools to help me automate the task as much as possible. The tool I am thinking about would ideally have the following features: Parse a PHP project tree and tell me where there are undocumented files, classes, and functions/methods (i.e. elements missing the appropriate docblock comment) Provide a method to half-way easily add the missing docblocks by creating the empty structures and, ideally, opening the file in an editor (internal or external I don't care) so I can put in the description. Optional: Automatic recognition of parameter types, return values and such. But that's not really required. The language in question is PHP, though I could imagine that a C/Java tool might be able to handle PHP files after some tweaking. Looking forward to your suggestions! Bounty There are already very good suggestions for this (that I have not yet had the time to check out) to point out the gaps, but none yet providing aid in filling them. I want to give the question some more exposure, maybe there is some sort of a graphical extension to php_codesniffer to achieve the level of automation I'm dreaming of. Looking forward to any additional input!

    Read the article

  • phpDocumentor alternative consuming less memory

    - by Michal Cihar
    Okay, I'm fed up with phpDocumentator. It consumes way much more memory and time than I'm willing to give it. Does there exist some really compatible program to generate documentation for PHP code? I've tried PHPDoctor, which looks nice, but it has some missing features. I've also tried PhpDocGen, but it just bails out with some Perl errors, which I'm too lazy to study. Doxygen also does not seem to play well with our sources. PS: The documentation would be for phpMyAdmin, a little bit outdated documentation is here.

    Read the article

  • A tool to find and fix incomplete source code documentation

    - by Pekka
    I have several finished, older PHP projects with a lot of includes that I would like to document in javadoc/phpDocumentor style. While working through each file manually and being forced to do a code review alongside the documenting would be the best thing, I am, simply out of time constraints, interested in tools to help me automate the task as much as possible. The tool I am thinking about would ideally have the following features: Parse a PHP project tree and tell me where there are undocumented files, classes, and functions/methods (i.e. elements missing the appropriate docblock comment) Provide a method to half-way easily add the missing docblocks by creating the empty structures and, ideally, opening the file in an editor (internal or external I don't care) so I can put in the description. Optional: Automatic recognition of parameter types, return values and such. But that's not really required. The language in question is PHP, though I could imagine that a C/Java tool might be able to handle PHP files after some tweaking. Thanks for your great input!

    Read the article

  • Netbeans-esque retrospective auto-comment/phpDocumentor tool (for Eclipse or standalone)

    - by Andy
    Is there anything similar to netbean's Javadoc auto comment tool for PHP/phpDocumentor/Eclipse? In the netbeans implementation: A dialog pops up and allows you to run through all the members of your class and enter comments, which are added to the source file. It even verifies that there are no parameters you have not accounted for, so you can be sure that your comments are complete. Ideally this would be standalone software, but plugins are OK too :) p.s. netbeans 6+ auto comment was moved/renamed. Now in "Tool-Options", Tab: "Java Code", Javadoc: "Hints" edit: screengrab of the original Netbeans tool:

    Read the article

  • How to mark array value types in PHP (Java)Doc?

    - by Christian Sciberras
    It might be a bit difficult to explain, so I'll give some example code. Note that I'm using NetBeans IDE (latest). class Dummy { public function say(){ } } /** * Builds dummy class and returns it. * @return Dummy The dummy class. */ function say_something(){ return new Dummy(); } $s=say_something(); While developing in netbeans I can invoke auto-complete by hitting ctrl+space after typing "$s-". In the the hint window that follows, there is the item "say()". This is because the javadoc says say_something returns a Dummy and NetBeans parsed Dummy class to know that it has a method called "say()". So far so good. My problem is with arrays. Example code follows: /** * Builds array of 2 dummy classes and returns it. * @return Array The dummy class. (*) */ function say_something2(){ return array(new Dummy(),new Dummy()); } $s=say_something2(); If I try the auto-complete thing again but with "$s[0]-" instead, I don't get the methods fro Dummy class. This is because in the JavaDoc I only said that it is an array, but not the values' type. So the question would be, is there any JavaDoc syntax, cheat, whatever which allows me to tell JavaDoc what type of variables to expect in an array?

    Read the article

1 2  | Next Page >