Comments (4)
You only need the .csproj as the documentation source. SHFB will figure out what it needs from that (assemblies, references, and comments files). If you delete the content folder, remove the content layout file too. I assume you did since there would likely be build errors otherwise about the missing conceptual topics. Assuming the APIs you want to document are public, they should appear. If they're not public, they won't appear by default unless you enable the appropriate options in the Visibility project property category.
from shfb.
You only need the .csproj as the documentation source. SHFB will figure out what it needs from that (assemblies, references, and comments files). If you delete the content folder, remove the content layout file too. I assume you did since there would likely be build errors otherwise about the missing conceptual topics. Assuming the APIs you want to document are public, they should appear. If they're not public, they won't appear by default unless you enable the appropriate options in the Visibility project property category.
Yeah maybe I didn't explain myself correctly I'll try to illustrate it with the following:
Imagine I have the following namespaces:
-
MyLibrary.Repositories => This namespace has public classes and they are detected by the Help builder.
-
MyLibrary.Repositories.Definition => This namespace only contains public interfaces. This should be detected by the help builder and documented but it doesn't at the moment.
-
MyLibrary.Repositories.Implementation => This namespace contains the internal classes that implement the interfaces of the above namespace. As they aren't public they aren't detected as expected and not shown in the documentation.
But the thing is that the namespace MyLibrary.Repositories.Definition doesn't appear at all when it should.
from shfb.
Can you provide an example I can build to duplicate the issue?
from shfb.
Nvm, I fixed it. I deleted de documentation project and created it anew and now it works fine ! Also I left the title box empty this time, maybe that is what fixed the problem, leaving it here in case someone encounters the same issue:
from shfb.
Related Issues (20)
- With .NET 8 SDK, `BinaryFormatter` seems to be disallowed, resulting in some plugin failures HOT 11
- Nested `private protected` types incorrectly included in documentation HOT 2
- C# `init` property accessors documented as `set` HOT 3
- Please document methods parameters regardless syntax filters setup HOT 2
- BE0066: ResolveReferenceLinksComponent: [...] Member ID URL resolver service failed. HOT 5
- `See` element and override within sealed class HOT 2
- Easy to conflict with Microsoft.Help.F1 HOT 4
- autoOutline differences between Default2022 and VS2013 styles HOT 5
- Cannot install extension on arm64 HOT 1
- Enable TOC using current presentation style HOT 4
- TOC overlaying wide content HOT 4
- Building with NuGet tools with MsBuild is broken in Visual Studio HOT 4
- Numeric constant formatting for enumeration to allow searching for constant HOT 2
- Error BE0065: An error occurred while attempting to transform the reflection data to a topic. When Extensions Methods to Enum. HOT 3
- Some types excluded from documentation? HOT 3
- Documenting a `net8.0` project when using `msbuild.exe` HOT 3
- Linux/Docker builds HOT 5
- An error occurred while attempting to transform the reflection data to a topic. The error message was: System.NullReferenceException HOT 3
- Problem with installer when only VS 2022 is installed. HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from shfb.