Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Please document methods parameters regardless syntax filters setup #1038

Closed
msdobrescu opened this issue Jan 19, 2024 · 2 comments
Closed

Please document methods parameters regardless syntax filters setup #1038

msdobrescu opened this issue Jan 19, 2024 · 2 comments

Comments

@msdobrescu
Copy link

I've tried to generate a documentation out of an API without needing specific syntax filters (C#, VB etc.).
When no syntax filters are selected, the API is documented as expected, except for the methods parameters or return values.
This is not expected.
The parameters can be documented based on their XML entries at least.

Please add the parameters in this case too, as they don't depend on anything.

If the types are the problem, can present the CLR type names, like "System.Boolean", "System.Byte", "System.Int16", "System.Int32", "System.Int64", "System.SByte", "System.UInt16", "System.UInt32", "System.UInt64", "System.Decimal", "System.Single", "System.Double" and so on.
So can be applied to the return values.

@EWSoftware
Copy link
Owner

It may be possible with a generic syntax generator but I'm curious as to the use case for this. Why would you want to document the API without syntax filters of any kind? If I'm going to use an API, I want to see syntax and usage examples in the language of my choice.

@msdobrescu
Copy link
Author

In my team we don't need that at all. Just to know the parameters, their base types and meaning/purpose.
Also, not generating them was a surprise, a warning or a message would have been nice (to state the reason).
Struggled a day to find the reason and articles or discussion on the Internet were misleading in this matter.
"String" or "Integer" are enough to us.

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

No branches or pull requests

2 participants