frankframework / frankframework/frank-doc

Bug: Empty keys from single-`#` lines cause blank entries in Frank!Doc output

Open
#407 0 comments 0 reactions 0 assignees View on GitHub
doclet
Dominant language
Java
Stars
5
Forks
5
Avg merge
1h 20m
Merged PRs (30d)
1

Description

#### Description

Frank!Doc intentionally parses commented-out properties and properties without values to include them in the documentation. For example:

- `#property.name` → is correctly parsed as a property named `property.name` with no default value or description.
- `## Description`
`#property` → is parsed as a property named `property` with the description: `Description`.

I think this behavior is **intended** and **not a bug**.

However, a line like:

```properties
#
```

results in a **property with an empty key and no description**, which causes a **blank row** to appear in the generated documentation table.

#### Example

Code reference:
[`AppConstants.properties#L489`](https://github.com/frankframework/frankframework/blob/317ea9ff54490e56c56b371a491177e5a0b2eb22/core/src/main/resources/AppConstants.properties#L489)

#### Screenshot

![Blank Row Output](https://github.com/user-attachments/assets/f7f15912-a4af-4543-bf10-e16762c77934)

#### Expected Behavior

Lines that consist of only a single `#`, or whitespace-only comment lines, should be ignored by the parser and **not result in documented properties**.

#### Actual Behavior

They are currently parsed as properties with empty keys, resulting in blank entries.

#### Proposed Solution

- Update the parser to **skip lines** where the resulting key is empty after parsing.
- Optionally log a warning or ignore such entries entirely during documentation generation.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.