Is it possible to generate doxygen compatible comments using MathWorks code generation products?
MATLAB: How to generate doxygen compatible comments using MathWorks code generation products
cgtcodecommentsdoxygengenerationsimulinktemplate
Related Solutions
1.) The simplest use for the CGT is to be used for code markup, in fact much of the surface level functionality is geared towards this. For example we provide four built in definitions for code mark up:
File Banner Section
(Optional) This section contains comments and tokens you use in generating a custom file banner.
Function Banner Section
(Optional) This section contains comments and tokens for use in generating a custom function banner.
Shared Utility Function Banner Section
(Optional) This section contains comments and tokens for use in generating a custom shared utility function banner.
File Trailer Section
(Optional) This section contains comments for use in generating a custom trailer banner.
An example syntax would be something like this:
<FunctionBanner style = "open_box" width = "80"> Model Name : %<ModelName>
FunctionName : %<FunctionName>
Return Type : %<ReturnType>
Arguments : %<Arguments>
Block : %<GeneratedFor>
Abstract : %<FunctionDescription>
Block Description : %<BlockDescription style = "content_only">
</FunctionBanner>Which would subsequently generate this in the code:
More in-depth syntax for these sections is described on this page here:
And the example that this was drawn from can be opened using
>> rtwdemo_codetemplate2.) You can also use the CGT file to simply drop text you would like to have placed in the generated code before or after a desired section. For example if I modify this section of the CGT from this:
%<Includes>
%<Defines>
%<Types>
%<Enums>
%<Definitions>
%<Declarations>
%<Functions>
To this:
#include topinclude.h %<Includes> #include bottominclude.h %<Defines> %<Types> %<Enums> %<Definitions> %<Declarations> %<Functions>then the subsequent code generation will produce the following:
This covers the basic functionality of the CGT file.
3.) Now, for more advanced use and specification of custom tokens, sections and subsections we need to bring in the Custom File Processing (CFP) template file described here:
The CFP file can be used for a few purposes, the most important of which are, generating your own additional source and header files, and modifying the predefined source and header files that normally get generated. The following code in a CFP file can be used to modify the standard generated header file, and serves as a good template for how to modify the predefined sections in the CGT file:
%%Add a #define to the model's public header file model.h
%assign pubName = LibGetMdlPubHdrBaseName()
%assign modelH = LibCreateSourceFile("Header", "Simulink", pubName)
%openfile tmpBuf
#define ACCELERATION 9.81 %closefile tmpBuf
%<LibSetSourceFileSection(modelH,"Defines",tmpBuf)>
The %assign statements are getting the name of the generated header file and grabbing the file itself
The text inside the %openfile %closefile pair is what we want to append to the header file
And the final statement is pushing the text from the buffer tmpBuf and appending it to modelH (the header file we specifed earlier) at the "Defines" section.
The entirety of the CFP doc page is a very good start if you want to dive deeper into TLC code generation and manipulating the Code Generation Output and I would suggest following through the example if you want to understand more about the creation of custom sections to use in the CGT file, or other customization of the code generation process. I would also just like to mention that if you do make custom modifications to the code generation process, we cannot guarantee the functionality of the newly modified code, so always make sure to check the effects of modifying these files.
To center an image in a report programmatically , you can modify the "Style" property of the image. The "Style" property of an image and other DOM document objects is a cell array of format objects, which you can use to style the DOM document object. Here is an example of how you can add a "HAlign" object to "Style" property of the "thePlot" image to center it in the PDF:
plotPath = getSnapshotImage(fig, R);halign = mlreportgen.dom.HAlign('center');thePlot.Style = [thePlot.Style(:)' {halign}];However, adding a "VAlign" format object to the "Style" property of the image will not vertically align the image to the center of the page. PDF viewers honor the "VAlign" property only for DOM objects that are children of objects that have a specifiable height. Although pages have a specifiable height, they are not DOM objects so adding a "VAlign" object to the style property of an image that is a child of a page will not center the image. However, you can vertically align an image using the "VAlign" format object on a page if the image is a child of a 1 by 3 invisible table whose width and height are equivalent to the page body's width and height. To see an example, open the script "alignImage.m" attached and look at the "centerImage" function in the script for details..
Related Question
- How to make a system able to find a file under the MATLAB root directory
- What is the purpose of Code Generation Template (CGT) files
- How can you view the function call event for a function call subsystem
- How to call custom MATLAB functions in code generation templates (.cgt) files
- How to customize the “main” function generated by Real-Time Workshop Embedded Coder 5.2 (R2008b)
- How to avoid having information on date and time of file creation when generating code from a Simulink model
- Can’t I use the “Tune…” button on the “PID Controller” block
Best Answer