Stack Overflow
Stack Overflow

Questions tagged [apigen]

ApiGen is an API documentation generator for PHP 5.3+

ApiGen is a tool for creating API documentation from PHP source code, similar to phpDocumentor/phpDoc.

ApiGen has support for PHP 5.3 namespaces, packages, linking between documentation, cross referencing to PHP standard classes and general documentation, creation of highlighted source code and experimental support for PHP 5.4 traits.

ApiGen uses a Nette Framework templating system and Texy to produce useful and easy to read HTML documentation, FSHL to create highlighted source code and TokenReflection to describe the documented source code.

23 questions
5
votes
0 answers

How do I make an inline @link to another class in Apigen?

I'm trying to create a @link from one method to another method in a different class. Example: class Bar extends Foo { /** * This link works: {@link barFunction()} * This link also works: {@link fooFunction()} * This link doesn't…
Matey
  • 1,190
  • 5
  • 7
4
votes
4 answers

How do I exclude multiple folders in Apigen?

What is the correct syntax for the CLI to exclude multiple folders in ApiGen? I tried separating them with comma, but that's ignored (probably read as one path): H:\SERVER>php apigen.phar generate --source [PATH] --destination [PATH] --exclude…
Anastasia Sitnina
  • 551
  • 8
  • 24
4
votes
2 answers

I can't install and run ApiGen

I'm creating a PHP micro-framework and decided to use ApiGen to generate the API. When I use the "apigen" command on terminal, I get the following message: sh.exe": apigen: command not found. Maybe it is the directory…
Gabriel Jacinto
  • 81
  • 1
  • 7
3
votes
1 answer

API Gen with NetBeans 7.2.1

I cannot generate the documentation of my project. Getting the error message under NetBeans "'"php.exe"' is not recognized as an internal or external command, operable program or batch file.". The ApiGen 2.8.0 standalone has been unzipped in a…
Franz Froch
  • 31
  • 1
  • 2
2
votes
1 answer

How to prevent ApiGen from using fully-qualified names when replacing @link

We currently use ApiGen to document our PHP classes. Inside our doc comments, there are a lot of inline @link statements like this: {@link AbstractValidatableItem} When running ApiGen, the statement expands to a link like this (please ignore…
Michael Jaros
  • 4,586
  • 1
  • 22
  • 39
2
votes
1 answer

ApiGen on windows.Can't able to run apigen command

Can anybody tell how to get working APIGen on windows. I have installed ApiGen using PEAR and the file of ApiGen resides in C:\wamp\bin\php\php5.3.13 there are two types of file here one with batch extension and other with file extension both…
user3724677
  • 1,691
  • 3
  • 12
  • 10
1
vote
1 answer

Does ApiGen 5 support multiple file extensions?

I am using ApiGen 5.0.0-RC3, and I cannot figure out how to get it to search for .class files and .inc files as well as .php files. My question is twofold: firstly, is it possible to get ApiGen to recognize .class files, and secondly, if it is…
Lux
  • 1,540
  • 1
  • 22
  • 28
1
vote
1 answer

sublime-3 apigen destination not set error

i've just installed apigen package on sublime 3. When i run apigen->generate, console says: "Destination is not set. Use '-d' or config to set it" here is my apigen.neon file source: /mysourcefolder destination: …
Withoutness
  • 11
  • 1
1
vote
1 answer

Regex Replace Nette and Latte in ApiGen

I'm using the Bootstrap Template for ApiGen and I want to replace the default source code views with Highlight.js. This requires me to remove the existing spans produced by ApiGen using the Nette replaceRE filter. The original code looks like…
secondman
  • 3,233
  • 6
  • 43
  • 66
1
vote
1 answer

APIGen neon config file format

I'm trying to run APIGen v4 but I can't get the config file to parse properly. Does anyone have a working example of a APIGen neon config file which works with APIGen v4?
Adrian Walls
  • 852
  • 3
  • 19
  • 31
1
vote
1 answer

Using Apigen in Netbeans IDE

I have been trying to use the Apigen script to do documentation in Netbeans. I downloaded Apigen.phar file and created the Apigen.bat file. I added the location of it into the Netbeans in the Apigen section. When I try to do the documentation for…
Nael Saeed
  • 27
  • 1
  • 8
1
vote
1 answer

Handling Laravel's UserTrait with ApiGen

I've started using ApiGen with a Laravel project. When I run it, I get the following error: The class Illuminate\Auth\UserTrait is in use but has not been found in the defined sources. Clearly it's complaining because Laravel's UserTrait isn't…
Matthew Daly
  • 9,212
  • 2
  • 42
  • 83
1
vote
1 answer

Using APIGEN with Netbeans and Virtualbox

My dev environment has an ubuntu server 14.04 running inside a VirtualBox. I use Mac OS X where I have Netbeans and other supporting software installed. Only the server component resides in VirtualBox. Mac OS X |- Netbeans |- VirtualBox |-- Ubuntu…
Magesh Ravi
  • 31
  • 4
0
votes
1 answer

How to make work in ApiGen

Tying to generate auto doc using ApiGen. Have add followed comment for doc generation. I was hope that block in "code" will make same appearance as in short's description, but it does not work. I'm not sure how to make the same. Are there some…
webmak10
  • 479
  • 1
  • 7
  • 18
0
votes
0 answers

I am unable to install ApiGen om a mac

I am unable to install ApiGen om a mac. I did everything as instructed on apigen.org: wget http://apigen.org/apigen.phar chmod +x apigen.phar mv apigen.phar /usr/local/bin/apigen apigen --version And this is the result I get everytime! sh-3.2# wget…
MemesisZX
  • 31
  • 7
1
2