Skip to content

Docs: Missing API reference #1093

@akrzemi1

Description

@akrzemi1

It looks like the library docs are missing API reference at a sufficiently detailed level.
https://develop.decimal.cpp.al/decimal/decimal32_t.html lists all member functions in decimal32_t, but those member functions are never described. I mean things like preconditions and postconditions.

I wanted to check from the docs what happens if I initialize a decimal32_t with integer values that the type cannot possibly represent. API reference is a natural place to look for such things. I do not even know if this library as a concept of "overflow" or -- like for float they simply degenerate into subnormal values and infinities.
Are there integer values that I can pass to the constructor that would be an "invalid use", or are any inputs valid and form a number, infinity at worse?

Metadata

Metadata

Assignees

No one assigned

    Labels

    Boost ReviewCollected Comments from Boost Review PerioddocumentationImprovements or additions to documentation

    Type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions