langref-ctags

This repository provides, for a number of projects:

Scripts for obtaining the official reference in text file / Markdown form,
A ctags index that contains identifiers, types, and signatures, and points at the relevant documentation sections.

In combination with a ctags-compatible text editor, this can enable:

Auto-completion
Search and browsing of library symbols
Viewing detailed documentation by using the "go to definition" functionality
...

Limitations

The client must support filenames relative to the tags file.

Inclusion Criteria

The documentation must be freely available and redistributable.

Suitable: glibc, POSIX C API, ...
Unsuitable: ISO C, ABAP, ...

The project is not distributed in a form where a suitable tags file could be auto-generated.

Suitable: documentation is separate from the source files, e.g. POSIX C, Lua standard library, ...
Unsuitable: a project where symbol documentation is next to the symbol in the source code, e.g. when using Doxygen/Javadoc/... or simply well-commented header files, ...

The nature of the documented project must be suitable for the ctags format.

Suitable: Languages with little to no symbol overloading, e.g. C, ...
Unsuitable: Projects where a lot of different symbols share a name, e.g. the Java Platform API

License

All contents of this repository are licensed as CC0 / Public domain. The converted documentation is not part of this project, it remains with its original license.