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

ApiGlobalSection don't keep order given in annotation ApiGlobal #177

Closed
BobbyWhiskey opened this Issue Jan 14, 2016 · 0 comments

Comments

Projects
None yet
2 participants
@BobbyWhiskey

BobbyWhiskey commented Jan 14, 2016

Hi
I just saw that some time my global documentation is not in the correct order in the generated html. For example i have something like this for my global doc:

@ApiGlobal(
    sections = {
        @ApiGlobalSection( title = "General documentation",
            paragraphs = {
                    "/jsondocfile:/jsondocfile/general-doc.html"
                    }
            ),
        @ApiGlobalSection( title = "Another section",
            paragraphs = {
                    "/jsondocfile:/jsondocfile/other-section.html"
                    }
            ),
                      // More sections here...
        }
    )
public class GlobalDocumentation {
}

On the generated html, the order is not always the same order specified in my GlobalDocumentation class.
I believe the source of the problem is in class ApiGlobalDoc line 18. The HashSet used does not guarantee the order of the sections.

@fabiomaffioletti fabiomaffioletti added this to the 1.2.12 milestone Apr 14, 2016

@fabiomaffioletti fabiomaffioletti self-assigned this Apr 14, 2016

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