rhys-vdw / rhys-vdw/lua-doc-extractor

Multiple `@enum` annotations in a single comment causes unexpected output

Open
#44 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
2
Forks
3
Avg merge
2m
Merged PRs (30d)
1

Description

	/***
	 * Piece flag for `Spring.UnitScript.Explode`.
	 * 
	 * @enum SHATTER integer
	 * @enum EXPLODE integer
	 * @enum EXPLODE_ON_HIT integer
	 * @enum FALL integer
	 * @enum SMOKE integer
	 * @enum FIRE integer
	 * @enum NONE integer
	 * @enum NO_CEG_TRAIL integer
	 * @enum NO_HEATCLOUD integer
	 * @enum RECURSIVE integer
	 */
---Piece flag for `Spring.UnitScript.Explode`.
---
---@enum SHATTER integer
---
---integer
---
---integer
---
---integer
---
---integer
---
---integer
---
---integer
---
---integer
---
---integer
---
---integer
SHATTER = {}

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the annotation parsing entry point that handles repeated @enum lines, then compare the C-style comment with the generated Lua shown in the issue. Done means the multiple enum annotations produce the intended Lua output rather than the repeated blank and integer entries shown.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua, typescript
Domain
documentation, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.