File names

Whether or not you are a Core HaXXor, you may be used to reading the source code for the libraries you are using, perhaps to understand how those libraries work in more detail.

The first step is to find the file containing the code that deals with a particular data structure. libart tries to make this process easy for you. File names are structured as follows: art_sourcestructure_deststructure_details.{h|c}. For example, the source file art_svp_vpath.h contains the source code which manipulates svp data structures and generates vpath data structures. Most notably, the following function can be found in there: art_svp_from_vpath.

I hope you will get used to the marvelous world of documentation by code since everyone knows that the code is the ultimate source of rightness.