How to deal with cross assembly crefs

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

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
csharp
Domain
documentation, tooling

Research direction

Start by examining how api-docs-sync handles triple-slash comments, IntelliSense XML, and cref values during the System.IO experiment. Reproduce the cross-assembly reference from FileSystemName to System.IO.FileSystemWatcher and compare the docs build with the compiler's CS1574 diagnostic. Done means the source-of-truth workflow preserves the reference without triggering that compiler error.

Written by the indexing model from the issue text.

Description

port-to-tripleslash

I backported docs to System.IO as an experiment. It made FileSystemName (which is in corelib) have <see cref="System.IO.FileSystemWatcher" /> (which is in a different assembly). This is fine for the docs build because its context is apparently "everything". However the compiler complains with CS1574 and I have to remove the cref.

When making code the source of truth, how can we preserve cref's across assemblies?

@carlossanlop

Dominant language
C#
Stars
14
Forks
21
No merged PRs in 30d

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.

More from dotnet/api-docs-sync

All issues in dotnet/api-docs-sync

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.