This is a migrated thread and some comments may be shown as answers.

Generate documentation for all the methods and empty returns section

3 Answers 36 Views
General Discussions
This is a migrated thread and some comments may be shown as answers.
This question is locked. New answers and comments are not allowed.
Chap
Top achievements
Rank 1
Chap asked on 09 Jul 2013, 07:27 AM
1. Is there any way to generate documentation for all the methods in a class file using just code. Now I can generate documentation for only one method at one time. 

2. Why there is nothing generated for return section in documentation? Do we have to manually add those?

I am using vs 2008 and Justcode 2012 sp1 

3 Answers, 1 is accepted

Sort by
0
Zdravko
Telerik team
answered on 09 Jul 2013, 07:59 AM
Hi Chap,

 Thanks for contacting us.

So far there is no command that could generate documentation for all your methods or types at once.
I would suggest posting a feature request at our feedback portal where you and the community could vote for it. 

Our Generate Documentation command provides only basic structure which the user has to improve in order to suits his needs.
What should we generate for the return section according to you?
Thanks.

Regards,
Zdravko
Telerik
Share what you think about JustCode with us, so we can help you even better! You can use the built-in feedback tool inside JustCode, our forum, or our JustCode feedback portal.
0
Chap
Top achievements
Rank 1
answered on 09 Jul 2013, 08:33 AM
Well, Thanks for your reply, I'll ask for that feature.

Yeah, As you said generating return is complicated. I am looking for this kind of scenario.

Thanks

/// <summary>
/// Adds the number.
/// </summary>
/// <returns>Addition Result</returns>
private int addNumber()
{
    int additionResult;
    additionResult = 3 + 5;
    return additionResult;
}
0
Zdravko
Telerik team
answered on 10 Jul 2013, 12:00 PM
Hello Chap,

 Thanks for the reply.
We will discuss your suggestion within the team and will consider it for implementation.
Thank you.

Regards,
Zdravko
Telerik
Share what you think about JustCode with us, so we can help you even better! You can use the built-in feedback tool inside JustCode, our forum, or our JustCode feedback portal.
Tags
General Discussions
Asked by
Chap
Top achievements
Rank 1
Answers by
Zdravko
Telerik team
Chap
Top achievements
Rank 1
Share this question
or