Skip to content

Commit

Permalink
Add doxygen_modules.h header file (#194)
Browse files Browse the repository at this point in the history
Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
  • Loading branch information
Mario-DL authored and EduPonz committed Feb 22, 2024
1 parent adfd1ce commit 8242cbb
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions include/fastcdr/config/doxygen_modules.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
// Copyright 2024 Proyectos y Sistemas de Mantenimiento SL (eProsima).
//
// Licensed 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.

/**
* @file doxygen_modules.h
*/

#ifndef FASTCDR_DOXYGEN_MODULES_H_
#define FASTCDR_DOXYGEN_MODULES_H_

/*!
* @defgroup FASTCDRAPIREFERENCE FastCDR Serializer API Reference
* @brief FastCDR Serializer internal API groped in modules.
*/

/*!
* @defgroup EXCEPTIONMODULE Exceptions
* @ingroup FASTCDRAPIREFERENCE
* @brief Exceptions used by the FastCDR API.
* All exceptions defined in this module are thrown by the FastCDR library.
*/

#endif /* FASTCDR_DOXYGEN_MODULES_H_ */

0 comments on commit 8242cbb

Please sign in to comment.