Skip to content

Conversation

viborc
Copy link

@viborc viborc commented May 9, 2025

This commit adds a comprehensive prompt for generating Doxygen-style documentation for Python code. Doxygen is a documentation generator that extracts structured comments from code to create reference documentation.

The AI Agent with this prompt does the following:

  • Implements the ## comment style specifically for Python
  • Defines documentation structures for functions, classes, and modules
  • Provides templates for @brief summaries, parameter descriptions, return values, and exceptions
  • Includes guidelines for documenting class variables and instance variables
  • Outlines a 4-step documentation process: code analysis, critical elements, quality writing, and consistency
  • Emphasizes explaining the "why" behind code, not just functionality
  • Includes examples of proper @code usage for demonstrating implementation

This commit adds a comprehensive prompt for generating Doxygen-style documentation for Python code. Doxygen is a documentation generator that extracts structured comments from code to create reference documentation. 

The AI Agent with this prompt does the following:

- Implements the ## comment style specifically for Python
- Defines documentation structures for functions, classes, and modules
- Provides templates for @brief summaries, parameter descriptions, return values, and exceptions
- Includes guidelines for documenting class variables and instance variables
- Outlines a 4-step documentation process: code analysis, critical elements, quality writing, and consistency
- Emphasizes explaining the "why" behind code, not just functionality
- Includes examples of proper @code usage for demonstrating implementation
Copy link
Collaborator

@pablo-forgood-ai pablo-forgood-ai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I cannot approve this PR in its current state due to a syntax error in the DoxyGen Docs Generator configuration file.

On line 6, there's a missing closing quotation mark in the "File Search" tool entry:

"File Search,

@pablo-forgood-ai
Copy link
Collaborator

Also make the file ".json"

@viborc
Copy link
Author

viborc commented Jun 5, 2025

Hello @pablo-forgood-ai - thank you for your review on this one as well. As with the previous one, the changes have been made. Please review and check again when you catch a moment.

Copy link
Collaborator

@pablo-forgood-ai pablo-forgood-ai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you.

Please correct these tool names:

Semantic Code Search -> (does not exist?)
Full Text Search -> full_text_search
File Search -> file_search
Fetch -> webpage_content
File Editor -> file_edit

Thanks a lot in advance

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants