Skip to content
This repository has been archived by the owner on Aug 9, 2022. It is now read-only.

Add namespace to the Class/Interface documentation #9

Open
steffen-wilke opened this issue Apr 5, 2019 · 4 comments
Open

Add namespace to the Class/Interface documentation #9

steffen-wilke opened this issue Apr 5, 2019 · 4 comments

Comments

@steffen-wilke
Copy link

Right now, the Namespace: property doesn't show up anything.

Example:
image

@andrei-punko
Copy link
Contributor

As I remember - it's expected behavior. Need to ask @superyyrrzz to confirm

@superyyrrzz
Copy link
Collaborator

Looks like it needs some minor template fix to make Java reference works well. To make the request clear, what do you expect to see in Namespace and Assembly? @steffen-wilke

@steffen-wilke
Copy link
Author

@superyyrrzz In general, I'd expect the Namespace of the Class/Interface as already present in the navigation on the left.

Example:
image

For Assembly is think the bahavior is not 100% clear for java projects. At best we could display the project name here or if we have a maven project, the name of the .jar library (e.g. groupId + artifactId). But in my opinion, this is not really something that can be transfered directly from C# projects to Java projects so maybe it's best to leave it blank or remove the Assembly(if possible).
In my particular case of the LITIengine I would have hidden this element via template.

@superyyrrzz
Copy link
Collaborator

superyyrrzz commented Apr 9, 2019

@steffen-wilke Thank you for the feedback. That makes sense to me.

In general, I'd expect the Namespace of the Class/Interface as already present in the navigation on the left.

@v-anpunko I think the data is already in the package field. Then we can use this.

maybe it's best to leave it blank or remove the Assembly

Totally agree on this.

Create an issue in DocFX to track this: dotnet/docfx#4326

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants