Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Define $pack_id and $generator_id for generator arguments #238

Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 22 additions & 12 deletions doxygen/src/generators_schema.txt
Original file line number Diff line number Diff line change
Expand Up @@ -141,29 +141,39 @@ Grouping element for \b generators. Only one such group can exist in a Pack.
<th>Description</th>
</tr>
<tr>
<td>$P</th>
<td>PATH to current project</th>
<td>$P</td>
<td>PATH to current project</td>
</tr>
<tr>
<td>\#P</th>
<td>PATH and name of the current project</th>
<td>\#P</td>
<td>PATH and name of the current project</td>
</tr>
<tr>
<td>$S</th>
<td>PATH to Pack folder containing the Device description used by the current project</th>
<td>$S</td>
<td>PATH to Pack folder containing the Device description used by the current project</td>
</tr>
<tr>
<td>$D</th>
<td>Name of the device configured in the current project</th>
<td>$D</td>
<td>Name of the device configured in the current project</td>
</tr>
<tr>
<td>$B</th>
<td>Name of the board configured in the current project</th>
<td>$B</td>
<td>Name of the board configured in the current project</td>
</tr>
<tr>
<td>$G</th>
<td>$G</td>
<td>Absolute PATH to the generator input file describing the project and component context.
Note $G is only available in the \c \<command> and \c \<argument> elements</th>
Note $G is only available in the \c \<command> and \c \<argument> elements</td>
</tr>
<tr>
<td>$pack_id</td>
<td>Provide an easy way for the generator to know its' pack. Typically useful if you launch
the same generator program from multiple generator definitions. YAML format.</td>
</tr>
<tr>
<td>$generator_id</td>
<td>Provide an easy way for the generator to know its' name. Typically useful if you launch
the same generator program from multiple generator definitions.</td>
</tr>
</table>
<p>&nbsp;</p>
Expand Down
Loading