Source view is not working

[filips123]

Source view is not working in phpDocumentor3, but it works in phpDocumentor2.

Expected Behavior

Source view should show source code of the file.

Actual Behavior

Source view shows blank two lines.

Steps to Reproduce the Problem

1. Create few files with docBlocks.
2. Create documentation with phpDoc 2.
3. Create documentation with phpDoc 3.
4. Open source view of file.

Your environment

• Version used: v3.0.0-alpha.2
• Install method: PHAR
• PHP version: 7.2.6
• Operating system and version: Ubuntu 16.04 on Codenvy PHP stack

Screenshots

phpDocumentor2:

phpDocumentor3:

[jaapio]

It should work when you provide the --source flag. This was a bug in phpdoc v2 that always added the source to the docs.

Please let me know if this works for you.

[filips123]

I currently can't test this. I will test this on next Thursday.

[jaapio]

I just checked it myself, the --sourcecode flag is not working correctly right now. To fix an other issue I enabled it by default like it was done in phpdoc 2. I will leave this issue open to be sure that we fix this issue in the future the right way.

The latest nightly build will contain the fix and help you forward.

[mussaweralyasah]

@jaapio how did you enabled it by default. i am new to this i want the source code to be in the documentation.
right now clicking on the button of source code shows
✖ Error: File does not exist or is empty
i want it to show the source code in documentation

[PauchardThomas]

Same problem.

✖ Error: File does not exist or is empty

• Env : Windows
• Version : v3.0.0-alpha.3
• PHP : 7.2.6
• Command : phpDocumentor run -d src/ -t doc/ --template="clean" --sourcecode

[mvriel]

This issue is resolved on develop. You can now use the --sourcecode flag or the include-source configuration option to enable this feature. It is disabled by default.

I have also adjusted the default template (called 'clean') to not show the button to open up the source view. Previously it was always there and showed an empty result when you tried to use it.

Please also keep in mind that opening the source view from file:// is not possible because it is loaded asynchronously and browsers block asynchronous requests from file://

[mvriel]

I will close this issue for now; if the issue persists for you, please add an update to the issue and we will reopen it

[oliveratgithub]

or the include-source configuration option to enable this feature.

@mvriel can you give an example how exactly I'd have to add this to a custom XML-configuration file for phpDocumentor? Thanks

[MarabyAidara]

tried php tools/phpDocumentor --sourcecode -d <path-to-my-symfony-project> -t <path-to-folder-output>
.
The doc is generated with the classes and methods but still I can't view the source code .
I am using phpDocumentor v3.0.0-beta with php 7.3.
Any help is welcome !