Re: Idea for documentation makeover
- Posted by _tom (admin) Nov 16, 2012
- 1072 views
The O S A I ( or o s a i ) are like the old RDS documents. (A bit of nostalgia here.)
The advantage of this style is it is easier to put the entire signature on one line.
If the parameter list contains a typedef then it could look like:
public function seek(file_number fn, file_position pos)
possible alternative:
public function seek( file_numberfn , file_positionpos )
Again, this does not require a rewrite of the documentation.
