Skip to content

Add doc for methods#68

Merged
fantazio merged 14 commits intoLexiFi:masterfrom
fantazio:doc_methods
Apr 1, 2026
Merged

Add doc for methods#68
fantazio merged 14 commits intoLexiFi:masterfrom
fantazio:doc_methods

Conversation

@fantazio
Copy link
Copy Markdown
Collaborator

Fix #59

The new documentation provides some preliminary definitions to understand what the analyzer tracks and may report in the methods section.
It also provides examples focusing on different simple code constructs (classes, inheritance, coercion, ...), and document known limitations.

The code of the examples explored in the .md files is also provided in its own files to ease user experimentation, and is included in the testsuite.

fantazio added 13 commits March 23, 2026 13:40
Provide defintions, related compiler warnings, and basic usage
information about unused methods.
This demonstrates the use by explicit references and use by
requirements. It also shows that unused methods can coexist with unused
values.
This demonstrates the use by explict references and use by
requirements.
This demonstrates the current silencing of class types.
This demonstrates the "unification" onf re-exported methods.
list the class type limitation
This is the same as the class type example.
This demonstrates the current silencing of object types.
This is the same as the class example with extra initialisers.
This shows that in the presence of aliases, the analyzer avoid duplicate
reports but also fails to properly track uses through aliases, resulting
in false positives.
This shows that coercing an object implies use by requirements.
This shows that analyzing objects produced by factory functions is the
same as considering the function as its resulting object.
This is the same as the class example with a polymorphic stack and
without the unnecessary classes.
Apply suggestions from code review

Co-authored-by: Corentin De Souza <fantazio@users.noreply.github.com>
@fantazio fantazio merged commit 8309b46 into LexiFi:master Apr 1, 2026
5 checks passed
@fantazio fantazio deleted the doc_methods branch April 1, 2026 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document the unused methods section

1 participant