blob: 8bd9e7d5c6cf550fd201ad8a29a5a079275023e2 [file] [log] [blame]
/**************************************************************
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
#ifndef ARY_INFO_INFTYPES_HXX
#define ARY_INFO_INFTYPES_HXX
// USED SERVICES
// BASE CLASSES
// COMPONENTS
// PARAMETERS
namespace ary
{
namespace info
{
typedef uintt GlobalTextId;
/** Because this enum is used as index list for displayed
tag headlines, the items must neither be moved nor deleted.
Only adding to the end is allowed. atid_MAX always has to exist
and to be the last used value.
Also assigning numbers to the values is forbidden.
*/
enum E_AtTagId
{
atid_ATT = 0,
atid_author,
atid_change,
atid_collab,
atid_contact,
atid_copyright,
atid_deprecated,
atid_descr,
atid_docdate,
atid_derive,
atid_dyn,
atid_instance,
atid_interface,
atid_invariant,
atid_life,
atid_multi,
atid_onerror,
atid_persist,
atid_postcond,
atid_precond,
atid_resp,
atid_return,
atid_short,
atid_todo,
atid_version,
atid_MAX
};
/** Because this enum is used as index list for displayed
tag headlines, the items must neither be moved nor deleted.
Only adding to the end is allowed. C_eAtTag_NrOfClasses always has to exist
and to be the last used value.
Also assigning other numbers to the values, than in this
existing scheme, is forbidden.
*/
enum E_AtTagClass
{
atc_std = 0,
atc_base = atid_MAX,
atc_exception = atid_MAX + 1,
atc_implements = atid_MAX + 2,
atc_keyword = atid_MAX + 3,
atc_parameter = atid_MAX + 4,
atc_see = atid_MAX + 5,
atc_template = atid_MAX + 6,
atc_label = atid_MAX + 7,
atc_since = atid_MAX + 8,
C_eAtTag_NrOfClasses
};
} // namespace info
} // namespace ary
#endif