docs: update CLAUDE.md with MCRF_* macro documentation system
Updated documentation guidelines to reflect the new macro-based system: - Documented MCRF_METHOD and MCRF_PROPERTY usage - Listed all available macros (MCRF_SIG, MCRF_DESC, MCRF_ARG, etc.) - Added prose guidelines (concise C++, verbose external docs) - Updated regeneration workflow (removed references to deleted scripts) - Emphasized single source of truth and zero-drift architecture Removed references to obsolete hardcoded documentation scripts that were deleted in previous commits. Related: #92 (Inline C++ documentation system)
This commit is contained in:
parent
cc80964835
commit
4c61bee512
2 changed files with 221 additions and 54 deletions
|
|
@ -108,7 +108,7 @@
|
|||
<body>
|
||||
<div class="container">
|
||||
<h1>McRogueFace API Reference</h1>
|
||||
<p><em>Generated on 2025-10-30 11:47:05</em></p>
|
||||
<p><em>Generated on 2025-10-30 12:33:46</em></p>
|
||||
<p><em>This documentation was dynamically generated from the compiled module.</em></p>
|
||||
|
||||
<div class="toc">
|
||||
|
|
@ -424,15 +424,37 @@ Attributes:
|
|||
<h4>Methods:</h4>
|
||||
|
||||
<div style="margin-left: 20px; margin-bottom: 15px;">
|
||||
<h5><code class="method-name">get_boundsGet bounding box as (x, y, width, height)</code></h5>
|
||||
<h5><code class="method-name">get_boundsget_bounds() -> tuple</code></h5>
|
||||
<p>Get the bounding rectangle of this drawable element.
|
||||
|
||||
|
||||
|
||||
Note:</p>
|
||||
<p style='margin-left: 20px;'><span class='returns'>Returns:</span> tuple: (x, y, width, height) representing the element's bounds The bounds are in screen coordinates and account for current position and size.</p>
|
||||
</div>
|
||||
|
||||
<div style="margin-left: 20px; margin-bottom: 15px;">
|
||||
<h5><code class="method-name">moveMove by relative offset (dx, dy)</code></h5>
|
||||
<h5><code class="method-name">movemove(dx: float, dy: float) -> None</code></h5>
|
||||
<p>Move the element by a relative offset.
|
||||
|
||||
|
||||
Note:</p>
|
||||
<div style='margin-left: 20px;'>
|
||||
<div><span class='arg-name'>dx</span>: Horizontal offset in pixels</div>
|
||||
<div><span class='arg-name'>dy</span>: Vertical offset in pixels</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div style="margin-left: 20px; margin-bottom: 15px;">
|
||||
<h5><code class="method-name">resizeResize to new dimensions (width, height)</code></h5>
|
||||
<h5><code class="method-name">resizeresize(width: float, height: float) -> None</code></h5>
|
||||
<p>Resize the element to new dimensions.
|
||||
|
||||
|
||||
Note:</p>
|
||||
<div style='margin-left: 20px;'>
|
||||
<div><span class='arg-name'>width</span>: New width in pixels</div>
|
||||
<div><span class='arg-name'>height</span>: New height in pixels</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -462,15 +484,37 @@ Attributes:
|
|||
<h4>Methods:</h4>
|
||||
|
||||
<div style="margin-left: 20px; margin-bottom: 15px;">
|
||||
<h5><code class="method-name">get_boundsGet bounding box as (x, y, width, height)</code></h5>
|
||||
<h5><code class="method-name">get_boundsget_bounds() -> tuple</code></h5>
|
||||
<p>Get the bounding rectangle of this drawable element.
|
||||
|
||||
|
||||
|
||||
Note:</p>
|
||||
<p style='margin-left: 20px;'><span class='returns'>Returns:</span> tuple: (x, y, width, height) representing the element's bounds The bounds are in screen coordinates and account for current position and size.</p>
|
||||
</div>
|
||||
|
||||
<div style="margin-left: 20px; margin-bottom: 15px;">
|
||||
<h5><code class="method-name">moveMove by relative offset (dx, dy)</code></h5>
|
||||
<h5><code class="method-name">movemove(dx: float, dy: float) -> None</code></h5>
|
||||
<p>Move the element by a relative offset.
|
||||
|
||||
|
||||
Note:</p>
|
||||
<div style='margin-left: 20px;'>
|
||||
<div><span class='arg-name'>dx</span>: Horizontal offset in pixels</div>
|
||||
<div><span class='arg-name'>dy</span>: Vertical offset in pixels</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div style="margin-left: 20px; margin-bottom: 15px;">
|
||||
<h5><code class="method-name">resizeResize to new dimensions (width, height)</code></h5>
|
||||
<h5><code class="method-name">resizeresize(width: float, height: float) -> None</code></h5>
|
||||
<p>Resize the element to new dimensions.
|
||||
|
||||
|
||||
Note:</p>
|
||||
<div style='margin-left: 20px;'>
|
||||
<div><span class='arg-name'>width</span>: New width in pixels</div>
|
||||
<div><span class='arg-name'>height</span>: New height in pixels</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -514,7 +558,13 @@ Attributes:
|
|||
</div>
|
||||
|
||||
<div style="margin-left: 20px; margin-bottom: 15px;">
|
||||
<h5><code class="method-name">get_boundsGet bounding box as (x, y, width, height)</code></h5>
|
||||
<h5><code class="method-name">get_boundsget_bounds() -> tuple</code></h5>
|
||||
<p>Get the bounding rectangle of this drawable element.
|
||||
|
||||
|
||||
|
||||
Note:</p>
|
||||
<p style='margin-left: 20px;'><span class='returns'>Returns:</span> tuple: (x, y, width, height) representing the element's bounds The bounds are in screen coordinates and account for current position and size.</p>
|
||||
</div>
|
||||
|
||||
<div style="margin-left: 20px; margin-bottom: 15px;">
|
||||
|
|
@ -523,7 +573,15 @@ Attributes:
|
|||
</div>
|
||||
|
||||
<div style="margin-left: 20px; margin-bottom: 15px;">
|
||||
<h5><code class="method-name">moveMove by relative offset (dx, dy)</code></h5>
|
||||
<h5><code class="method-name">movemove(dx: float, dy: float) -> None</code></h5>
|
||||
<p>Move the element by a relative offset.
|
||||
|
||||
|
||||
Note:</p>
|
||||
<div style='margin-left: 20px;'>
|
||||
<div><span class='arg-name'>dx</span>: Horizontal offset in pixels</div>
|
||||
<div><span class='arg-name'>dy</span>: Vertical offset in pixels</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div style="margin-left: 20px; margin-bottom: 15px;">
|
||||
|
|
@ -537,7 +595,15 @@ Attributes:
|
|||
</div>
|
||||
|
||||
<div style="margin-left: 20px; margin-bottom: 15px;">
|
||||
<h5><code class="method-name">resizeResize to new dimensions (width, height)</code></h5>
|
||||
<h5><code class="method-name">resizeresize(width: float, height: float) -> None</code></h5>
|
||||
<p>Resize the element to new dimensions.
|
||||
|
||||
|
||||
Note:</p>
|
||||
<div style='margin-left: 20px;'>
|
||||
<div><span class='arg-name'>width</span>: New width in pixels</div>
|
||||
<div><span class='arg-name'>height</span>: New height in pixels</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div style="margin-left: 20px; margin-bottom: 15px;">
|
||||
|
|
@ -625,15 +691,37 @@ Attributes:
|
|||
<h4>Methods:</h4>
|
||||
|
||||
<div style="margin-left: 20px; margin-bottom: 15px;">
|
||||
<h5><code class="method-name">get_boundsGet bounding box as (x, y, width, height)</code></h5>
|
||||
<h5><code class="method-name">get_boundsget_bounds() -> tuple</code></h5>
|
||||
<p>Get the bounding rectangle of this drawable element.
|
||||
|
||||
|
||||
|
||||
Note:</p>
|
||||
<p style='margin-left: 20px;'><span class='returns'>Returns:</span> tuple: (x, y, width, height) representing the element's bounds The bounds are in screen coordinates and account for current position and size.</p>
|
||||
</div>
|
||||
|
||||
<div style="margin-left: 20px; margin-bottom: 15px;">
|
||||
<h5><code class="method-name">moveMove by relative offset (dx, dy)</code></h5>
|
||||
<h5><code class="method-name">movemove(dx: float, dy: float) -> None</code></h5>
|
||||
<p>Move the element by a relative offset.
|
||||
|
||||
|
||||
Note:</p>
|
||||
<div style='margin-left: 20px;'>
|
||||
<div><span class='arg-name'>dx</span>: Horizontal offset in pixels</div>
|
||||
<div><span class='arg-name'>dy</span>: Vertical offset in pixels</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div style="margin-left: 20px; margin-bottom: 15px;">
|
||||
<h5><code class="method-name">resizeResize to new dimensions (width, height)</code></h5>
|
||||
<h5><code class="method-name">resizeresize(width: float, height: float) -> None</code></h5>
|
||||
<p>Resize the element to new dimensions.
|
||||
|
||||
|
||||
Note:</p>
|
||||
<div style='margin-left: 20px;'>
|
||||
<div><span class='arg-name'>width</span>: New width in pixels</div>
|
||||
<div><span class='arg-name'>height</span>: New height in pixels</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -743,7 +831,13 @@ Attributes:
|
|||
</div>
|
||||
|
||||
<div style="margin-left: 20px; margin-bottom: 15px;">
|
||||
<h5><code class="method-name">get_boundsGet bounding box as (x, y, width, height)</code></h5>
|
||||
<h5><code class="method-name">get_boundsget_bounds() -> tuple</code></h5>
|
||||
<p>Get the bounding rectangle of this drawable element.
|
||||
|
||||
|
||||
|
||||
Note:</p>
|
||||
<p style='margin-left: 20px;'><span class='returns'>Returns:</span> tuple: (x, y, width, height) representing the element's bounds The bounds are in screen coordinates and account for current position and size.</p>
|
||||
</div>
|
||||
|
||||
<div style="margin-left: 20px; margin-bottom: 15px;">
|
||||
|
|
@ -777,11 +871,27 @@ Attributes:
|
|||
</div>
|
||||
|
||||
<div style="margin-left: 20px; margin-bottom: 15px;">
|
||||
<h5><code class="method-name">moveMove by relative offset (dx, dy)</code></h5>
|
||||
<h5><code class="method-name">movemove(dx: float, dy: float) -> None</code></h5>
|
||||
<p>Move the element by a relative offset.
|
||||
|
||||
|
||||
Note:</p>
|
||||
<div style='margin-left: 20px;'>
|
||||
<div><span class='arg-name'>dx</span>: Horizontal offset in pixels</div>
|
||||
<div><span class='arg-name'>dy</span>: Vertical offset in pixels</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div style="margin-left: 20px; margin-bottom: 15px;">
|
||||
<h5><code class="method-name">resizeResize to new dimensions (width, height)</code></h5>
|
||||
<h5><code class="method-name">resizeresize(width: float, height: float) -> None</code></h5>
|
||||
<p>Resize the element to new dimensions.
|
||||
|
||||
|
||||
Note:</p>
|
||||
<div style='margin-left: 20px;'>
|
||||
<div><span class='arg-name'>width</span>: New width in pixels</div>
|
||||
<div><span class='arg-name'>height</span>: New height in pixels</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -857,15 +967,37 @@ Attributes:
|
|||
<h4>Methods:</h4>
|
||||
|
||||
<div style="margin-left: 20px; margin-bottom: 15px;">
|
||||
<h5><code class="method-name">get_boundsGet bounding box as (x, y, width, height)</code></h5>
|
||||
<h5><code class="method-name">get_boundsget_bounds() -> tuple</code></h5>
|
||||
<p>Get the bounding rectangle of this drawable element.
|
||||
|
||||
|
||||
|
||||
Note:</p>
|
||||
<p style='margin-left: 20px;'><span class='returns'>Returns:</span> tuple: (x, y, width, height) representing the element's bounds The bounds are in screen coordinates and account for current position and size.</p>
|
||||
</div>
|
||||
|
||||
<div style="margin-left: 20px; margin-bottom: 15px;">
|
||||
<h5><code class="method-name">moveMove by relative offset (dx, dy)</code></h5>
|
||||
<h5><code class="method-name">movemove(dx: float, dy: float) -> None</code></h5>
|
||||
<p>Move the element by a relative offset.
|
||||
|
||||
|
||||
Note:</p>
|
||||
<div style='margin-left: 20px;'>
|
||||
<div><span class='arg-name'>dx</span>: Horizontal offset in pixels</div>
|
||||
<div><span class='arg-name'>dy</span>: Vertical offset in pixels</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div style="margin-left: 20px; margin-bottom: 15px;">
|
||||
<h5><code class="method-name">resizeResize to new dimensions (width, height)</code></h5>
|
||||
<h5><code class="method-name">resizeresize(width: float, height: float) -> None</code></h5>
|
||||
<p>Resize the element to new dimensions.
|
||||
|
||||
|
||||
Note:</p>
|
||||
<div style='margin-left: 20px;'>
|
||||
<div><span class='arg-name'>width</span>: New width in pixels</div>
|
||||
<div><span class='arg-name'>height</span>: New height in pixels</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue