VirtualBox

Changeset 460 in vbox for trunk/include


Ignore:
Timestamp:
Jan 31, 2007 11:14:01 AM (18 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
18043
Message:

Fixed string to number function documentation.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/include/iprt/string.h

    r331 r460  
    614614
    615615
    616 /** @defgroup rt_str_conv   String To/From Number Convertions
     616/** @defgroup rt_str_conv   String To/From Number Conversions
    617617 * @ingroup grp_rt_str
    618618 * @{ */
     
    622622 *
    623623 * @returns iprt status code.
    624  *          Warnings are used to indicate convertion problems.
     624 *          Warnings are used to indicate conversion problems.
    625625 * @param   pszValue    Pointer to the string value.
    626626 * @param   ppszNext    Where to store the pointer to the first char following the number. (Optional)
    627627 * @param   uBase       The base of the representation used.
    628  *                      If the function will look for known prefixes before defaulting to 10.
     628 *                      If 0 the function will look for known prefixes before defaulting to 10.
    629629 * @param   pu64        Where to store the converted number. (optional)
    630630 */
     
    645645 *
    646646 * @returns iprt status code.
    647  *          Warnings are used to indicate convertion problems.
     647 *          Warnings are used to indicate conversion problems.
    648648 * @param   pszValue    Pointer to the string value.
    649649 * @param   ppszNext    Where to store the pointer to the first char following the number. (Optional)
    650650 * @param   uBase       The base of the representation used.
    651  *                      If the function will look for known prefixes before defaulting to 10.
     651 *                      If 0 the function will look for known prefixes before defaulting to 10.
    652652 * @param   pu32        Where to store the converted number. (optional)
    653653 */
     
    668668 *
    669669 * @returns iprt status code.
    670  *          Warnings are used to indicate convertion problems.
     670 *          Warnings are used to indicate conversion problems.
    671671 * @param   pszValue    Pointer to the string value.
    672672 * @param   ppszNext    Where to store the pointer to the first char following the number. (Optional)
    673673 * @param   uBase       The base of the representation used.
    674  *                      If the function will look for known prefixes before defaulting to 10.
     674 *                      If 0 the function will look for known prefixes before defaulting to 10.
    675675 * @param   pu16        Where to store the converted number. (optional)
    676676 */
     
    691691 *
    692692 * @returns iprt status code.
    693  *          Warnings are used to indicate convertion problems.
     693 *          Warnings are used to indicate conversion problems.
    694694 * @param   pszValue    Pointer to the string value.
    695695 * @param   ppszNext    Where to store the pointer to the first char following the number. (Optional)
    696696 * @param   uBase       The base of the representation used.
    697  *                      If the function will look for known prefixes before defaulting to 10.
     697 *                      If 0 the function will look for known prefixes before defaulting to 10.
    698698 * @param   pu8         Where to store the converted number. (optional)
    699699 */
     
    714714 *
    715715 * @returns iprt status code.
    716  *          Warnings are used to indicate convertion problems.
     716 *          Warnings are used to indicate conversion problems.
    717717 * @param   pszValue    Pointer to the string value.
    718718 * @param   ppszNext    Where to store the pointer to the first char following the number. (Optional)
    719719 * @param   uBase       The base of the representation used.
    720  *                      If the function will look for known prefixes before defaulting to 10.
     720 *                      If 0 the function will look for known prefixes before defaulting to 10.
    721721 * @param   pi64        Where to store the converted number. (optional)
    722722 */
     
    737737 *
    738738 * @returns iprt status code.
    739  *          Warnings are used to indicate convertion problems.
     739 *          Warnings are used to indicate conversion problems.
    740740 * @param   pszValue    Pointer to the string value.
    741741 * @param   ppszNext    Where to store the pointer to the first char following the number. (Optional)
    742742 * @param   uBase       The base of the representation used.
    743  *                      If the function will look for known prefixes before defaulting to 10.
     743 *                      If 0 the function will look for known prefixes before defaulting to 10.
    744744 * @param   pi32        Where to store the converted number. (optional)
    745745 */
     
    760760 *
    761761 * @returns iprt status code.
    762  *          Warnings are used to indicate convertion problems.
     762 *          Warnings are used to indicate conversion problems.
    763763 * @param   pszValue    Pointer to the string value.
    764764 * @param   ppszNext    Where to store the pointer to the first char following the number. (Optional)
    765765 * @param   uBase       The base of the representation used.
    766  *                      If the function will look for known prefixes before defaulting to 10.
     766 *                      If 0 the function will look for known prefixes before defaulting to 10.
    767767 * @param   pi16        Where to store the converted number. (optional)
    768768 */
     
    783783 *
    784784 * @returns iprt status code.
    785  *          Warnings are used to indicate convertion problems.
     785 *          Warnings are used to indicate conversion problems.
    786786 * @param   pszValue    Pointer to the string value.
    787787 * @param   ppszNext    Where to store the pointer to the first char following the number. (Optional)
    788788 * @param   uBase       The base of the representation used.
    789  *                      If the function will look for known prefixes before defaulting to 10.
     789 *                      If 0 the function will look for known prefixes before defaulting to 10.
    790790 * @param   pi8        Where to store the converted number. (optional)
    791791 */
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette