Skip to content

Commit f9d67db

Browse files
committed
Add doxygen group for HAL specification
Add the doxygen group hal_specification as a container group for all the API specifications.
1 parent 4978a08 commit f9d67db

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

hal/test-headers/hal_specification.h

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
/* mbed Microcontroller Library
2+
* Copyright (c) 2017-2017 ARM Limited
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+
/**
18+
* \defgroup hal_specification HAL specification
19+
* Technical specification of the HAL consisting of defined behavior, tests which verify this behavior and behaior not defined by this specification.
20+
* @{
21+
*/
22+
23+
24+
#ifndef HAL_SPECIFICATION_H
25+
#define HAL_SPECIFICATION_H
26+
27+
28+
#ifdef __cplusplus
29+
extern "C" {
30+
#endif
31+
32+
#ifdef __cplusplus
33+
}
34+
#endif
35+
36+
#endif
37+
38+
/**@}*/
39+

0 commit comments

Comments
 (0)