doxygen/dir.dox.sample

   1 /*
   2  * Copyright (c) <YEAR> <YOUR AFFILIATION HERE>
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /* Doxygen directory documentation */
  18
  19 /**
  20 @dir
  21 @brief Someone please fix this description.
  22 @todo This directory needs a description.
  23
  24 This is where you would document the contents of a directory.
  25
  26 This looks like a C file but it is not part of the build; it is purely
  27 for documentation.
  28 */
  29 /*? %%clicmd:group_label CLI section description%% ?*/
  30 /*? %%syscfg:group_label Startup config section description%% ?*/