You should check if your distribution is using the vanilla GLIBC or the EGLIBC fork (Debian and Ubuntu have switched to EGLIBC EDIT: they switched back around 2014). Anyway, the repository browser for GLIBC is at http://sourceware.org/git/?p=glibc.git http://code.woboq.org/userspace/glibc/, posted by @guruz below, is a good alternative. The source is a bit complicated by the presence … Read more
I really like Marginalia if you want to take something like a literate programming approach. Marginalia traverses your source code, and produces an html formatted version with comments set beside code in a very clear text. Comments can be markdown formatted, making for a very readable final document. When reviewing source code that I’ve written … Read more
As per Doxygen 1.8.7 there are three ways to do this: Use a standard markdown hyperlink as described in your original question. Use a @ref and prefix the target with md_ along with any subdirectories. Name the page and use @ref to refer to the name. The first method is straightforward and this will also … Read more
Swagger and Slate serve two different purposes. Swagger is an attempt at a standardized way of describing a RESTful API (similar, for example, to ApiBlueprint) Swagger is a JSON based API definition format, which allows for the description of REST APIs. ~ API Design Tooling From Swagger Slate, on the other hand is a pretty … Read more
Thanks to a comment from @Sorin, the official documentation is available here: http://www.jetbrains.org/intellij/sdk/docs/index.html Here are some docs: Lots of links here: http://confluence.jetbrains.net/display/IDEADEV/PluginDevelopment The SDK: http://confluence.jetbrains.net/display/IDEADEV/Getting+Started+with+Plugin+Development Also, from the above link, you can check out the source code to the community edition, which should effectively act as API docs: http://www.jetbrains.org/pages/viewpage.action?pageId=983225
Figured it out. The following inserts a relative reference to the document js/index.html: `Javascript API <js/index.html>`_
I was surprised that you could not simply write .rst stands for **r**e**s**tructured **t**ext. but the reStructuredText specification indeed states that inline markup must be followed by white-space or one of – . , : ; ! ? \ / ‘ ” ) ] } or >, so the above string of reStructuredText is not … Read more
You can use triple backticks: /** * Example usage: * * “` * @JavaAnnotation * public void foo() { * // Code * } * “` */
You can put example source code in a special path defined in the doxygen config under EXAMPLE_PATH, and then insert examples with the @example tag. Doxygen will then generate an extra page containing the source of the example. It will also set a link to it from the class documentation containing the example tag. Alternatively … Read more