@@ -1,7 +1,7 @@ /* - * Copyright (c) 2008 - 2009 + * Copyright (c) 2008 - 2010 * Jonathan Schleifer * * All rights reserved. * * This file is part of ObjFW. It may be distributed under the terms of the @@ -39,12 +39,11 @@ OF_NUMBER_FLOAT, OF_NUMBER_DOUBLE, }; /** - * The OFNumber class provides a way to store a number in an object and to - * manipulate it. + * \brief provides a way to store a number in an object and to manipulate it. */ @interface OFNumber: OFObject { union { char char_; @@ -536,42 +535,38 @@ * \return The OFNumber as a double */ - (double)asDouble; /** - * Adds the specified OFNumber to the OFNumber. - * * \param num The OFNumber to add + * \return The OFNumber added with the specified OFNumber */ - add: (OFNumber*)num; /** - * Subtracts the specified OFNumber from the OFNumber. - * * \param num The OFNumber to substract + * \return The OFNumber subtracted by the specified OFNumber */ - subtract: (OFNumber*)num; /** - * Multiplies the OFNumber with the specified OFNumber. - * * \param num The OFNumber to multiply with + * \return The OFNumber multiplied with the specified OFNumber */ - multiplyWith: (OFNumber*)num; /** - * Divides the OFNumber by the specified OFNumber. - * * \param num The OFNumber to divide by + * \return The OFNumber devided by the specified OFNumber */ - divideBy: (OFNumber*)num; /** - * Increases the OFNumber by 1. + * \return The OFNumber increased by one. */ - increase; /** - * Decreases the OFNumber by 1. + * \return The OFNumber decreased by one. */ - decrease; @end