Mike van Riel

Discussion: standardize namespace format

4

Currently you allow the namespace separator to be selectable and whether the namespace should start with a separator. Would it not be easier for people who create transformers if that...

Discussion: JSON vs. XML

3

I understand the negative bias that XML has in many cases due to verbosity but I need to ask what arguments were used to consider JSON. AFAIK are there no...

Custom annotations

1

DocBlocks can have custom annotations, such as @api (which tells the transformer that this element is an API method). I am missing a way to communicate these to the transformer

Missing intro for files

1

In COMMON you define a field intro (that can be mapped to the short description of PHPDoc) but files do not have that field

Change markup and language values to mime types

1

Perhaps an idea would be to use mime types as values for the config.markup and config.language fields; these are well-known and provide the possibility for parsers to provide types that...

SOURCE field can become a parsing issue

1

I am not sure whether including the full source uncompressed and unconverted will not break the JSON. For DocBlox we compress the file using gzip and then base64encode it so...

See https://github.com/phpDocumentor/phpDocumentor/issues/3184 and related tickets for the original report. When using special characters, these are URL encoded and phpDocumentor is unable to process this. What needs to be done is...

Invalidate cache when configuration changes

1

While working on PR #3289 I found that the caches are not invalidated when the API Specification changes between runs (probably similar for Guides). This mechanism is however required to...

Guides: Underscores in titles are gone

1

When you define a title with an underscore in it, you do not see it in the rendered output and it is not used in the anchor; thus linking to...