19 lines
3.0 KiB
JSON
19 lines
3.0 KiB
JSON
{
|
|
"model": "anthropic/claude-3.7-sonnet",
|
|
"messages": [
|
|
{
|
|
"role": "user",
|
|
"content": "# Context\r\n\r\n- ESP-32, Platform.io, C17\r\n- avoidance of std\r\n- industrial application, using Modbus-485\r\n\r\n## Instructions\r\n\r\n- Generate documentation for a given class, its types, enumerations, in a new Markdown file located at `./docs/modbus/<filename>.md`.\r\n- The documentation is intended for an Astro static site generator.\r\n- Include frontmatter in the Markdown file with `title`, `description`, and `keywords` fields.\r\n- You will be provided with the content of the component's header file (e.g., `src/modbus/<file-name>.h`).\r\n- Ensure the generated Markdown adheres to standard linting rules.\r\n- The generated Markdown document must follow the specific layout provided below.\r\n- The component's C++ source file will contain an example of how it is constructed and mounted; use this as a basis for the \"Example\" section in the documentation.\r\n- Do not comment or add thoughts, just output plain Markdown\r\n\r\n## Layout\r\n\r\nThe Markdown document must adhere to the following structure:\r\n\r\n----------------------------\r\n\r\n## COMPONENT NAME\r\n\r\n**Path**: `relative/path/to/component-name.cpp` (as a Markdown link)\r\n\r\n**Revision History**: Add a file revision entry in the header to track modifications. For the initial documentation, use \"Initial documentation\". Skip this if a revision history already exists !\r\n\r\nA detailed description of the component\r\n\r\n## REQUIREMENTS\r\n\r\nDetail the hardware pins and software dependencies required by the component.\r\n\r\n## PROVIDES\r\n\r\n- a list of all types, enumerations and classes\r\n\r\n## FEATURES\r\n\r\nList the key features and functionalities of the component.\r\n\r\n## DEPENDENCIES\r\n\r\n- Provide a list of dependencies as Markdown formatted links.\r\n- Include a minimal Mermaid diagram illustrating the dependencies. The diagram node names should not contain braces or brackets.\r\n\r\n## BEHAVIOUR\r\n\r\n- Include a minimal Mermaid diagram illustrating the component's behaviour or state machine. The diagram node names should not contain braces or brackets.\r\n\r\n\r\n## TODOS\r\n\r\n### PERFORMANCE\r\n\r\nOutline any performance considerations or areas for future optimization.\r\n\r\n### SECURITY\r\n\r\nDescribe potential security vulnerabilities or hardening measures.\r\n\r\n### COMPLIANCE\r\n\r\nNote any compliance standards or requirements relevant to the component.\r\n\r\n### RECOMMENDATIONS\r\n\r\nProvide any recommendations for using or extending the component.\r\n"
|
|
},
|
|
{
|
|
"role": "user",
|
|
"content": ""
|
|
},
|
|
{
|
|
"role": "user",
|
|
"path": "src/xtypes.h",
|
|
"content": "#ifndef TYPES_H\n#define TYPES_H\n\n#include <stdint.h>\n\ntypedef const char cchar;\ntypedef unsigned char uchar;\n\ntypedef unsigned long millis_t;\ntypedef unsigned short ushort;\ntypedef unsigned long ulong;\ntypedef long int lint;\ntypedef long long int llint;\n\n\n#endif"
|
|
}
|
|
],
|
|
"tools": []
|
|
} |