omdl  v0.9.5
OpenSCAD Mechanical Design Library
docs_module.scad
Go to the documentation of this file.
1 //! Module: Structural component specifications.
2 /***************************************************************************//**
3  \file
4  \author Roy Allen Sutton
5  \date 2024
6 
7  \copyright
8 
9  This file is part of [omdl] (https://github.com/royasutton/omdl),
10  an OpenSCAD mechanical design library.
11 
12  The \em omdl is free software; you can redistribute it and/or modify
13  it under the terms of the [GNU Lesser General Public License]
14  (http://www.gnu.org/licenses/lgpl.html) as published by the Free
15  Software Foundation; either version 2.1 of the License, or (at
16  your option) any later version.
17 
18  The \em omdl is distributed in the hope that it will be useful,
19  but WITHOUT ANY WARRANTY; without even the implied warranty of
20  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21  Lesser General Public License for more details.
22 
23  You should have received a copy of the GNU Lesser General Public
24  License along with the \em omdl; if not, write to the Free Software
25  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
26  02110-1301, USA; or see <http://www.gnu.org/licenses/>.
27 
28  \details
29 
30  \amu_define group_name (Structural)
31  \amu_define group_brief (Structural component specifications.)
32 
33  \amu_include (include/amu/pgid_pparent_path_n.amu)
34 *******************************************************************************/
35 
36 //----------------------------------------------------------------------------//
37 // group.
38 //----------------------------------------------------------------------------//
39 
40 /***************************************************************************//**
41  \amu_include (include/amu/group_in_parent_start.amu)
42 *******************************************************************************/
43 
44 //----------------------------------------------------------------------------//
45 // subgroups (1 level).
46 //----------------------------------------------------------------------------//
47 
48 /***************************************************************************//**
49  /+
50 
51  NOTE: each word group identifier should be capitalized.
52 
53  +/
54 
55  /+ define level1 groups +/
56 
57  \amu_define groups_level1
58  (
59  Utility_Pipe
60  )
61 
62  /+ remove newlines from identifiers +/
63 
64  \amu_replace groups_level1 (text="${groups_level1}" search="\n" replace=", ")
65 
66  /+ expand level1 groups +/
67 
68  \amu_define new_line
69  (
70  )
71 
72  \amu_foreach defgroup_level1
73  (
74  words=${groups_level1} separator="${new_line}"
75  text="\defgroup ${group}_\${x} \${x}"
76  )
77 *******************************************************************************/
78 
79 /***************************************************************************//**
80  /+ instantiate level1 groups +/
81 
82  \amu_text
83  (
84  ${defgroup_level1}
85  )
86 *******************************************************************************/
87 
88 //----------------------------------------------------------------------------//
89 
90 /***************************************************************************//**
91  \addtogroup \amu_eval(${group})
92 
93  \details
94 
95  General information on structural elements is available at [wikipedia].
96 
97  [wikipedia]: https://en.wikipedia.org/wiki/Structural_element
98 *******************************************************************************/
99 
100 //! @}
101 //! @}
102 
103 
104 //----------------------------------------------------------------------------//
105 // end of file
106 //----------------------------------------------------------------------------//