If it returns an int
your documentation should say that it returns an int. However, you can describe it:
/**
* @return int 0 on success, non-zero indicates failure
*/
This allows future expansion too. What if your exit code gets changed to provide more useful information than "yes" or "no"? "no, because XYZ" could be represented with a number other than 1
, and your documentation will still be correct (which means implementations of the function will not need changing unless they want to take advantage of the new information)