Coder Social home page Coder Social logo

Comments (4)

EWSoftware avatar EWSoftware commented on July 29, 2024

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.

alex13lopez avatar alex13lopez commented on July 29, 2024

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.

EWSoftware avatar EWSoftware commented on July 29, 2024

Can you provide an example I can build to duplicate the issue?

from shfb.

alex13lopez avatar alex13lopez commented on July 29, 2024

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:
image

from shfb.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.