How to make block description of a simulink function block displayed above function header?

Question

Xiaojie Qiu 2018-10-24

0
链接

此问题的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/425777-how-to-make-block-description-of-a-simulink-function-block-displayed-above-function-header

评论： Xiaojie Qiu 2018-10-29

Hi everyone,

I'm using simulink function block to generate C code. For simulink function block, I add a brief function description to the block as shown below on the left side.

After code generation, the function description is inserted inside the function body.

So, I want to know if there is a way to display this description above the function header instead of inside the function body?

Thanks!

0 个评论
显示 -2更早的评论隐藏 -2更早的评论

请先登录，再进行评论。

请先登录，再回答此问题。

Answer 1

zhichuan wang 2018-10-24

0
链接

此回答的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/425777-how-to-make-block-description-of-a-simulink-function-block-displayed-above-function-header#answer_343117

I think I get you point. You can modify the CODE TEMPLATES FILE in Configuration Parameters(Code Generation->Templates-Code templates-Source file template) to do what you want.

5 个评论
显示 3更早的评论隐藏 3更早的评论

Xiaojie Qiu 2018-10-24

编辑：Xiaojie Qiu 2018-10-24

在 MATLAB Online 中打开

Hi Zhichuan,

Thanks for your reply!

I tried to customize the code generation template file by modifying the section Function Banner as shown below.

%%Custom function banner section (optional)

Customize function banners by using the following predefined tokens:

%%%<ModelName>, %<FunctionName>, %<FunctionDescription>, %<Arguments>, 
%%%<ReturnType>, %<GeneratedFor>, %<BlockDescription>.
<FunctionBanner style="doxygen_qt">
Function Name                 : %<FunctionName>
Block Description             : %<BlockDescription>
Arguments                     : %<Arguments>
Return Type of Function       : %<ReturnType>
</FunctionBanner>

But the block description is still displayed inside the function body in the generated code:

/*!
 * Function Name                 : test_timestwo
 * Block Description             :
 * Arguments                     : uint32_T rtu_u)
 * Return Type of Function       : uint32_T
 */
uint32_T test_timestwo(uint32_T rtu_u)
{
  /*
   * Block description for '<Root>/timestwo':
   *  This function multiplies the input with two and then outputs the result as return value.
   *
   *  Input:
   *  u: uint32
   *
   *  Return:
   *  y: uint32
   */
  return rtu_u << 1;
}

Could you please give me more details about how to solve this problem?

zhichuan wang 2018-10-25

编辑：zhichuan wang 2018-10-25

在 MATLAB Online 中打开

Possible reason is that Custom function banner section is valid for generated functions. Thus, you should set the funciton, uint32_T test_timestwo(uint32_T rtu_u)", as an atomic unit and specify the function name as you want.
Please attach you model and related files. I need to know more details about your models.
The system target file ert.tlc is mostly used in my job. Custom function banner section in ert_code_template.cgt is as following:

%%Custom function banner section (optional)

Customize function banners by using the following predefined tokens:

%%%<ModelName>, %<FunctionName>, %<FunctionDescription>, %<Arguments>, 
%%%<ReturnType>, %<GeneratedFor>, %<BlockDescription>.
<FunctionBanner style="classic">
%<FunctionDescription>
%<BlockDescription>
</FunctionBanner>

Generated code is as following:

      /*
 * Output and update for atomic system: '<Root>/Subsystem'
 * Block description for: '<Root>/Subsystem'
 *   Subsystem Description: This is block description
 */
real32_T test_Subsystem(real32_T rtu_aa)
{
  /* Gain: '<S1>/Gain' */
  return StructPointer->a * rtu_aa;
}

zhichuan wang 2018-10-26

在 MATLAB Online 中打开

Hi, qxj

I've saved your model with previous version in 2017b with the help of others. After running your model in 2017b , I found that the generated code is different from yours in 2018a, which makes me confused.

/*
 * File: test_2017b_timestwo.c
 *
 * Code generated for Simulink model 'test_2017b'.
 *
 * Model version                  : 1.23
 * Simulink Coder version         : 8.13 (R2017b) 24-Jul-2017
 * C/C++ source code generated on : Fri Oct 26 08:51:02 2018
 *
 * Target selection: ert.tlc
 * Embedded hardware selection: Intel->x86-64 (Windows64)
 * Code generation objectives: Unspecified
 * Validation result: Not run
 *
 *
 * TLC version                    : 8.13 (Jul 25 2017)
 */

#include "test_2017b_timestwo.h"

/* Include model header file for global data */
#include "test_2017b.h"
#include "test_2017b_private.h"

/*!
 * Function Name                 : test_2017b_timestwo
 * Block Description             : Block description for: '<Root>/timestwo'
 *   This function multiplies the input with two and then outputs the result as return value.
 *
 *   Input:
 *   u: uint32
 *
 *   Return:
 *   y: uint32
 * Arguments                     : uint32_T rtu_u
 * Return Type of Function       : uint32_T
 */
uint32_T test_2017b_timestwo(uint32_T rtu_u)
{
  return rtu_u << 1;
}

/*
 * File trailer for generated code.
 *
 * [EOF]
 */
48

Xiaojie Qiu 2018-10-29

Hi Zhichuan,

after code generation by using MATLAB R2017b, I also got the same result as you.

So, I have to draw a conclusion, that this problem is a side effect due to MATLAB version.

If you have any idea in the future, please tell me how to solve it. Thanks for your help again!

qxj

请先登录，再进行评论。

How to make block description of a simulink function block displayed above function header?

0 个评论
显示 -2更早的评论隐藏 -2更早的评论

采纳的回答

5 个评论
显示 3更早的评论隐藏 3更早的评论

更多回答（0 个）

另请参阅

类别

标签

产品

版本

Community Treasure Hunt

How to make block description of a simulink function block displayed above function header?

0 个评论 显示 -2更早的评论隐藏 -2更早的评论

采纳的回答

5 个评论 显示 3更早的评论隐藏 3更早的评论

更多回答（0 个）

另请参阅

类别

标签

产品

版本

Community Treasure Hunt

0 个评论
显示 -2更早的评论隐藏 -2更早的评论

5 个评论
显示 3更早的评论隐藏 3更早的评论