Repository navigation
docs: rebuild public-api.md from the actual public surface - #136
Merged
Merged
Conversation
The old page named types that do not exist (NwcProperty, NwcPropertyCategory), claimed the NwcIO.Internal.* types are internal (they are public, consumed by the tests and CLI) and omitted major entry points. The tables are rebuilt from the types declared public at HEAD, grouped by namespace: the federation (NwcAssembly), clash detector/result/selection types, TimeLiner MS Project/Primavera/CSV serializers, sets, quick properties, appearance profiler, grids, measure, diff, spatial index, sectioning, redlines, cameras and the Save*/Export* entry points. Internal.* is now described as public but unsupported (making it internal is tracked by #103). Closes #90
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
src/:NwcProperty/NwcPropertyCategory→ replaced byNwcPropertyRecord(the exporter namesNwcIfcExporter/NwcGlbExporter/NwcObjExporterwere already fixed by fix: correct TimeLiner exports, clash pair counts and runnable samples #126).internalbehindInternalsVisibleTo— in fact everyNwcIO.Internal.*type ispublic(tests and CLI consume them directly). The page now says exactly that, with the honest compatibility position: public but unsupported implementation surface; making theminternalis a breaking change tracked by Make NwcIO.Internal.* types internal and add package API compatibility validation #103.src/NwcIO), grouped by namespace, and now include the previously missing surface:NwcAssemblyfederation,NwcReaderOptions,NwcClashTest/Result/Selection/Batch/Rule,NwcClashBcfExporter,NwcNwfManifest, TimeLiner MS Project/Primavera/CSV serializers, sets incl.NwcXmlSetSerializerandNwcSearchOperator,NwcQuickProperties, appearance profiler, grids, measure, diff,NwcSpatialIndex, sectioning, redlines, cameras/viewpoints,NwcXRef.TryResolve, geometry primitives, and the document/assemblySave*/Export*entry points.Verified: every named type greps to a
publicdeclaration insrc/NwcIO(the IFC/clash-report exporters are noted asinternal);docfx --warningsAsErrorsclean.Closes #90