Local file support in @see and @link #757

Open
tobiastom opened this Issue Feb 20, 2013 · 1 comment

Projects

None yet

2 participants

@tobiastom

It would be great if I could link to local (e.g. Markdown) files, which would get included into the documentation.

For example inside package, classes and methods I could use something like

@link Documentation/Guide/How-to-use-lala.md Guide on using lala

I think I can remember that it was supported in phpDoc 1.x, but it seems to be gone in 2.x.

@mvriel
Member
mvriel commented Apr 30, 2013

As far as I know relative links were not supported and it wasn't possible to include such files other than with the tutorial functionality (@ashnazg: is this correct).

We definitely want to be able to include external documents in the documentation, I will get back to this at a later moment (might be after 2.0 is released as we cannot add this before the 2.0 release!)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment