Support for description dictionaries

[erunion]

Right now, @api-throws has support for a dictionary-like type and subtype system where you can do {User} as your throws description to generate a description of "If the User cannot be found.".

It might be worth investigating at looking to replace that with a configurable dictionary of these types of common return, error, and parameter descriptions that you could easily drop in.

For example:

@api-throws:private {403} \ErrorRepresentation If the user was not found.

Imagine setting up a dictionary in your config like:

<dictionaries>
    <description id="user.not_found">If the user was not found.</description>
</dictionaries>

And then doing:

@api-throws:private {403} \ErrorRepresentation {user.not_found}

We should also retain the current sprintf-like functionality and support something like:

<dictionaries>
    <description id="common.not_found">If the %s was not found.</description>
</dictionaries>

@api-throws:private {403} \ErrorRepresentation {common.not_found:"user"}

Just an idea to consolidate and have consistent documentation error messaging.

[erunion]

I'm going to close this out as I have no longer think that this is worth the amount of effort it's going to require.

[erunion]

Not worth it right now.