autodoc/inc/ary/info/inftypes.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef ARY_INFO_INFTYPES_HXX
  21 #define ARY_INFO_INFTYPES_HXX
  22
  23
  24 // USED SERVICES
  25     // BASE CLASSES
  26     // COMPONENTS
  27     // PARAMETERS
  28
  29
  30 namespace ary
  31 {
  32 namespace info
  33 {
  34
  35
  36
  37
  38 typedef uintt GlobalTextId;
  39
  40
  41
  42 /** Because this enum is used as index list for displayed
  43     tag headlines, the items must neither be moved nor deleted.
  44     Only adding to the end is allowed. atid_MAX always has to exist
  45     and to be the last used value.
  46     Also assigning numbers to the values is forbidden.
  47 */
  48 enum E_AtTagId
  49 {
  50     atid_ATT = 0,
  51     atid_author,
  52     atid_change,
  53     atid_collab,
  54     atid_contact,
  55
  56     atid_copyright,
  57     atid_deprecated,
  58     atid_descr,
  59     atid_docdate,
  60     atid_derive,
  61
  62     atid_dyn,
  63     atid_instance,
  64     atid_interface,
  65     atid_invariant,
  66     atid_life,
  67
  68     atid_multi,
  69     atid_onerror,
  70     atid_persist,
  71     atid_postcond,
  72     atid_precond,
  73
  74     atid_resp,
  75     atid_return,
  76     atid_short,
  77     atid_todo,
  78     atid_version,
  79
  80     atid_MAX
  81 };
  82
  83 /** Because this enum is used as index list for displayed
  84     tag headlines, the items must neither be moved nor deleted.
  85     Only adding to the end is allowed. C_eAtTag_NrOfClasses always has to exist
  86     and to be the last used value.
  87     Also assigning other numbers to the values, than in this
  88     existing scheme, is forbidden.
  89 */
  90 enum E_AtTagClass
  91 {
  92     atc_std = 0,
  93
  94     atc_base = atid_MAX,
  95     atc_exception = atid_MAX + 1,
  96     atc_implements = atid_MAX + 2,
  97     atc_keyword = atid_MAX + 3,
  98     atc_parameter = atid_MAX + 4,
  99
 100     atc_see = atid_MAX + 5,
 101     atc_template = atid_MAX + 6,
 102     atc_label = atid_MAX + 7,
 103     atc_since = atid_MAX + 8,
 104     C_eAtTag_NrOfClasses
 105 };
 106
 107
 108
 109 }   // namespace info
 110 }   // namespace ary
 111
 112
 113 #endif
 114
 115 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */