Feb 4, 2013 at 3:26 PM
Edited Feb 4, 2013 at 3:28 PM
Given a selection of functions, where is the best place to document the concept of specific variables that are used as the input parameters and return values of multiple functions?
My key concern is making this information easily accessible for those who are referring to the documentation of any of such specific function, whilst keeping repetition to a minimum.
int GetMaskFromOrientationName(string name);
string GetNameFromOrientationMask(int mask);
int CountConnectionsBetweenOrientations(int maskA, int maskB);
For example, somebody reading about
might not know what a mask is. Likewise the same for the other two functions.