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

categorizing and prioritizing the methods, classes etc.. #209

Closed
tlq opened this issue May 11, 2016 · 3 comments
Closed

categorizing and prioritizing the methods, classes etc.. #209

tlq opened this issue May 11, 2016 · 3 comments

Comments

@tlq
Copy link

tlq commented May 11, 2016

I m trying to prioritize the methods or classes in the typedoc. So far i couldnt find any helpfull solution. would it be possible to prioritize the methods, classes, interfaces etc.. I mean is it possible to change the view structure without touching the library ?

@s-panferov
Copy link

Could you please provide some examples?

@tlq
Copy link
Author

tlq commented May 11, 2016

for modules simply putting all the important modules at the top of the document and unimportant modules at the bottom. I mean some kind of grouping the modules and methods.
let me explain it with methods:

lets say i have 3 methods
`
@priorty = 3
fillDays() {
for (let index = 1; index <= 31; index++) {
this.days.push(index);
}
}

@priorty = 1
fillYears() {
for (let index = this.yearToStart; index <= this.yearToEnd; index++) {
this.years.push(index);
}
}

@priorty = 2
changeDate(_day:number, _month:number, _year:number) {
this.buildDate(_day, _month, _year);
}`
and i want to shown in the doc exactly in this order (fillYears, changeDate, fillDays) . so i can highlight the important methods and group them, and unimportant methods at the bottom of the class (like setters and getters etc..).

@aciccarello
Copy link
Collaborator

Partially related is #112

@Gerrit0 Gerrit0 closed this as completed Nov 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants