Prev Up Next
Go backward to Specifying functions
Go up to User documentation of generic software components
Go forward to Tips

When it may be necessary to explain design decisions

Sometimes, if some aspect of a component interface design is different from what is usually described in textbooks or seen in other libraries, it is helpful to the user to explain it. For example, the SGI documentation of the STL queue adaptor takes the trouble to explain why the pop member function has a void return type.


 

Prev Up Next