I could see this PHPDoc block in the FakerPHP/Faker package, and I’m not aware what does @template mean? you can find it in the package’s main branch on this line Answer The @template annotation relates to a concept called Generics, which does not currently exist in PHP, but are a way of dynamical…
Tag: documentation
Why am I getting “forbidden” message on accessing /books path and 404 on accessing any book on BookStack
I have setup bookstack on Xampp + Windows 10. I am accessing it directly with apache server. When I try to acces “/books” url it show a blanck white page with “forbidden” written on it. I can create shelfs and books but when I try to open any created book it show a 404 Apache page like…
Lint dynamic return types in PHP
I would like to be able to autocomplete when using my following code. I have looked for a solution, but just can’t seem to find anything. This is about what my models look like. In the following example I would like to be able to tab example and test My function to retrieve a model: This is how I call
phpDocumentor – Do comment references to other elements need a fully qualified path?
I couldn’t really interpret a clear answer about this from the documentation. When adding a reference to another structural element in a @see or @param comment, for example, do I always need to use the fully qualified name of the element, even if the two elements are local to each other? e.g. Object hie…
PhpDocs: Possible to link method in parameter description?
Is it possible to link to another method/class/property/etc. inside my project inline inside the @deprecated tag? Like this: ? Answer According to PHPdoc.org, you could use the @see tag for that. Also, PHPdoc.org recommends to use @see in case of a @deprecated method: It is RECOMMENDED (but not required) to p…
What do #@+ and #@- in PHP comment blocks mean?
I’ve seen several PHP files where there are some special characters at the beginning of a doc block. It starts with /**#@+ some doc-text */ and ends with /**#@-*/. What do these symbols mean? I found that this seems to be used in various PHP frameworks (Zend, phpseclib, Magento) but couldn’t find …
Automatically create documentation by reading function comments (PHP)
Let’s say I have: By using get_class_methods(new myclass()); I can get the classes. Now my question is this: can I read the comments from the class function into a string? So I can create auto generated documentation. Answer You can’t get access to comments from PHP if the target file is included …