Magaox

agent_context.md

@@ -0,0 +1,65 @@
+Follow these code style and documentation rules exactly.
+
+1) File-Level Documentation
+- Each header/source should have a top Doxygen file block:
+  - \file
+  - \brief
+  - \author (if project uses it)
+
+2) Include Guards and Includes
+- Match existing project include-guard naming convention.
+- Keep include ordering consistent with project style.
+- Do not introduce new include style unless project already uses it.
+
+3) Function Declaration Documentation
+- Every function declaration must have a brief `///` summary.
+- Add a short `/** ... */` details block only when needed.
+- Document every parameter inline at declaration site using:
+  - `type name /**< [in] description */`
+- Apply to normal methods, constructors, slots, and signals.
+- Keep return-value docs where project uses them.
+
+4) Member Variable Documentation
+- Document non-trivial class members with `///`.
+- Describe role/ownership/state, not just type.
+
+5) Naming and Structure
+- Use project member naming convention (e.g. `m_` prefix).
+- Keep declaration ordering/grouping stable:
+  - public/protected/private
+  - slots/signals grouped consistently.
+- Leave a blank line between declarations for readability.
+
+6) Header vs Source Placement
+- Keep non-trivial definitions out of headers.
+- Move implementations to `.cpp` unless intentionally inline.
+
+7) Editing Discipline
+- Preserve existing behavior unless explicitly requested.
+- When renaming members/APIs, update all dependent call sites.
+- Keep changes minimal and scoped.
+
+8) Formatting and Verification
+- Run `clang-format` on touched files.
+- Ensure docs and naming are consistent after formatting.
+- Report any places where project style is ambiguous before making assumptions.
+
+9) Doxygen Named Section Ordering
+- For classes that expose configuration via member data + accessors, keep named sections split into:
+  - `... - Data` for protected/private member state
+  - `...` (without `- Data`) for public access functions
+- Place the `... - Data` section before the corresponding public accessor section.
+
+10) Header Declaration Parameter Docs
+- In headers, prefer inline parameter documentation on declarations (`type name /**< ... */`) rather than separate `\param` lists, unless there is a specific reason to deviate.
+
+11) PR Prompt Attribution
+- At the top of PR descriptions, include an explicit attribution line when work was performed with Codex.
+- Preferred format:
+  - `This work was performed by GPT-5.3-Codex in response to the prompt: "...".`
+- Include the primary user prompt verbatim (or a faithful condensed version if it is extremely long).
+
+When you finish:
+- Summarize what changed.
+- List affected files.
+- Note any follow-up items or potential edge cases.

include/app/clOptions.hpp

@@ -83,10 +83,13 @@ struct clOptions
     );
 
     /// Parse the command line
+    /**
+     * \todo test for descriptions of size 0 and with/without ending sentinel
+     */
     void parse( int argc,    ///< [in] From main(argc, argv), the number of command line arguments
                 char **argv, ///< in] From main(argc, argv), the command line arguments
-                std::vector<std::string> *nonOptions =
-                    0 ///< [out] [optional] the elements in argv which are not option or option-arguments.
+                std::vector<std::string> *nonOptions = 0 /**< [out] [optional] the elements in argv
+                                                       which are not option or option-arguments. */
     );
 
     /// Get the value of the option, if present.

include/improc/milkImage.hpp

@@ -847,6 +847,7 @@ const uint64_t &milkImage<dataT>::cnt0() const
     return m_image->md->cnt0;
 }
 
+
 } // namespace improc
 } // namespace mx