diff options
| author | Mark Spruiell <mes@zeroc.com> | 2018-01-17 15:31:02 -0800 |
|---|---|---|
| committer | Mark Spruiell <mes@zeroc.com> | 2018-01-17 15:31:02 -0800 |
| commit | f1565f0f13b88c1ab04fb66aff67e9ac443af8ac (patch) | |
| tree | 63286d397a95213db55a305cf1a48bcebf70047b /cpp/include/Ice/Format.h | |
| parent | More Travis CI fixes (diff) | |
| download | ice-f1565f0f13b88c1ab04fb66aff67e9ac443af8ac.tar.bz2 ice-f1565f0f13b88c1ab04fb66aff67e9ac443af8ac.tar.xz ice-f1565f0f13b88c1ab04fb66aff67e9ac443af8ac.zip | |
Adding doc comments to C++
Diffstat (limited to 'cpp/include/Ice/Format.h')
| -rw-r--r-- | cpp/include/Ice/Format.h | 25 |
1 files changed, 12 insertions, 13 deletions
diff --git a/cpp/include/Ice/Format.h b/cpp/include/Ice/Format.h index 4e756fd62ce..6753a98a473 100644 --- a/cpp/include/Ice/Format.h +++ b/cpp/include/Ice/Format.h @@ -15,27 +15,26 @@ namespace Ice { -// -// This enumeration describes the possible formats for classes and exceptions. -// - +/** + * Describes the possible formats for classes and exceptions. + */ #ifdef ICE_CPP11_MAPPING enum class FormatType : unsigned char #else enum FormatType #endif { - // - // Indicates that no preference was specified. - // + /** + * Indicates that no preference was specified. + */ DefaultFormat, - // - // A minimal format that eliminates the possibility for slicing unrecognized types. - // + /** + * A minimal format that eliminates the possibility for slicing unrecognized types. + */ CompactFormat, - // - // Allow slicing and preserve slices for unknown types. - // + /** + * Allow slicing and preserve slices for unknown types. + */ SlicedFormat }; |