![]() Listing 2.15 show doxygen documented functions Passed by value as they are implicitly assumed to be input.Īll doxygen parameter arguments MUST be whitespace aligned. With a suffixed, or after the practice MUST NOT be applied to normal parameters that are ![]() If the pointer is used as input, output or both) MUST be indicated The following doxygen parameters MUST be documented for everyįunction: and parameter MUST be documented if the return typeįunction arguments MUST be documented using the doxygen a function argument is a pointer, the data flow direction (indicating The doxygen documentation describing each function MUST be placedĪll function prototype declarations and function implementations MUSTīe placed in the correct sections in the source/header files. 32 * 33 * We kindly request you to use one or more of the following phrases to refer to 34 * foxBMS in your hardware, software, documentation or advertising materials: 35 * 36 * - ″This product uses parts of foxBMS®″ 37 * - ″This product includes parts of foxBMS®″ 38 * - ″This product is derived from foxBMS®″ 39 * 40 */ IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 28 * SERVICES LOSS OF USE, DATA, OR PROFITS OR BUSINESS INTERRUPTION) HOWEVER 29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 25 * DISCLAIMED. ![]() Neither the name of the copyright holder nor the names of its 19 * contributors may be used to endorse or promote products derived from 20 * this software without specific prior written permission. Redistributions in binary form must reproduce the above copyright notice, 15 * this list of conditions and the following disclaimer in the documentation 16 * and/or other materials provided with the distribution. ![]() Redistributions of source code must retain the above copyright notice, this 12 * list of conditions and the following disclaimer. 5 * 6 * SPDX-License-Identifier: BSD-3-Clause 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions are met: 10 * 11 * 1. reStructuredText Coding Guidelinesġ /** 2 * 3 * © 2010 - 2023, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
0 Comments
Leave a Reply. |