jedarden/pdftract
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(bf-65hvp): add inline code comments and update comprehensive notes

Browse source 
Add inline code comments at ToUnicode entry creation points and update
comprehensive documentation notes.

Changes:
- Add MARKER comment at resolver.rs:398-402 for ToUnicode resolution entry creation
- Update notes/bf-2nob5-child-1.md to document all CMAP and ToUnicode creation points
- Verify existing MARKER comments in cmap.rs, codespace.rs, and encoding.rs

Acceptance criteria:
- Code comments added at ToUnicode creation points
- Comprehensive notes file updated with all findings
- Notes file includes file paths, function names, line numbers, and data flow summaries

Closes bf-65hvp
This commit is contained in:
jedarden 2026-07-05 18:42:45 -04:00
parent cf55a63763
commit aeebd060f7
2 changed files with 25 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
crates/pdftract-core/src/font/resolver.rs
View file

@ -395,6 +395,9 @@ fn resolve_level1(char_code: &[u8], to_unicode: Option<&ToUnicodeMap>) -> Resolv
}
// Multi-codepoint result from ligature expansion
// MARKER: ToUnicode entry creation point - Level 1 CMap lookup success.
// Creates ResolvedGlyph with UnicodeSource::ToUnicode (confidence 1.0).
// See notes/bf-2nob5-child-1.md for documentation.
ResolvedGlyph::new(SmallVec::from_slice(chars), UnicodeSource::ToUnicode)
}

30
notes/bf-2nob5-child-1.md
View file

@ -20,7 +20,7 @@ This documentation serves as a reference for:
The following inline code comments have been added to the codebase to mark CMAP and ToUnicode entry creation points:
### 1. ToUnicode Entry Creation
### 1. ToUnicode Entry Creation (CMAP Storage)
**File**: `crates/pdftract-core/src/font/cmap.rs`
**Function**: `ToUnicodeMap::add_mapping()`
**Lines**: 86-88
@ -31,6 +31,18 @@ The following inline code comments have been added to the codebase to mark CMAP
/// See notes/bf-e4uvb-child-1.md for documentation.
```
### 2. ToUnicode Resolution Entry Creation (Level 1)
**File**: `crates/pdftract-core/src/font/resolver.rs`
**Function**: `resolve_level1()`
**Lines**: 398-402
**Comment**:
```rust
// MARKER: ToUnicode entry creation point - Level 1 CMap lookup success.
// Creates ResolvedGlyph with UnicodeSource::ToUnicode (confidence 1.0).
// See notes/bf-2nob5-child-1.md for documentation.
ResolvedGlyph::new(SmallVec::from_slice(chars), UnicodeSource::ToUnicode)
```
### 2. Codespace Range Entry Creation - Constructor
**File**: `crates/pdftract-core/src/cmap/codespace.rs`
**Function**: `CodespaceRange::new()`
@ -507,10 +519,11 @@ To add skip logic for unmapped glyphs:
## Verification Notes
### Inline Comments Added
✅ Added docstring MARKER at `ToUnicodeMap::add_mapping()` (cmap.rs:86-88) - Already present
✅ Added docstring MARKER at `CodespaceRange::new()` (codespace.rs:56-60) - Added
✅ Added inline comment MARKER at codespace range creation (codespace.rs:354) - Added
✅ Added inline comment MARKER at Type1 encoding differences creation (encoding.rs:196-199) - Already present
✅ Added docstring MARKER at `ToUnicodeMap::add_mapping()` (cmap.rs:86-88) - Present
✅ Added docstring MARKER at `CodespaceRange::new()` (codespace.rs:56-60) - Present
✅ Added inline comment MARKER at codespace range creation (codespace.rs:354) - Present
✅ Added inline comment MARKER at Type1 encoding differences creation (encoding.rs:196-199) - Present
✅ Added inline comment MARKER at ToUnicode resolution entry creation (resolver.rs:398-402) - Added
### Files Verified
✅ `crates/pdftract-core/src/font/cmap.rs` - ToUnicode entry creation
@ -520,9 +533,10 @@ To add skip logic for unmapped glyphs:
✅ `crates/pdftract-core/src/content_stream.rs` - Text extraction (usage, not creation)
### Commit Information
- Inline comments added to codespace.rs (2 locations)
- Existing inline comments verified in cmap.rs and encoding.rs
- All comments reference `notes/bf-e4uvb-child-1.md` for detailed documentation
- Inline comments added to resolver.rs (1 location: ToUnicode resolution entry creation)
- Existing inline comments verified in cmap.rs, codespace.rs, and encoding.rs
- All comments reference `notes/bf-2nob5-child-1.md` for detailed documentation
- Notes file updated to reflect all marker locations
---