KidN

I think there is a problem with MREFBuilder.

When I use MREFBuilder with "/Dep:" option and with "/internal+" option I get documentation for an additional empty namespace titled - "( Default namespace)" .

Eg: If I alter the included sample batch file to be like this ( assuming I have all the necessay files) -

MRefBuilder "c:\temp\*.dll" /dep:"C:\dep\*.dll" /out:reflection.org /internal+

I will get an additional namespace documented. You can see the empty namespace in reflection.org, reflection.xml. If I specify "/internal-" there is no additional empty namespace created.

Or am I missing something.

Any help would be much appreciated as it is holding my deployment of help files for a project I'm doing. Thanks.



Re: Developer Documentation and Help System HELP: MrefBuilder with /internal+ creates "(Default namespace)"

KidN

Am I the only one who is seeing it

Would somebody help me with this

It is causing lots of delays and I would surely like to have this issue resolved.

Thanks.






Re: Developer Documentation and Help System HELP: MrefBuilder with /internal+ creates "(Default namespace)"

EWoodruff

It's probably the global namespace.  It may contain attributes related to the assembly in general and compiler-generated classes and usually shows up in builds where "/internal+" was used.  I coded the help file builder to exclude it by default unless explicitly included.  If you're using your own build script, you can probably experiment with MRefBuilder's namespace ripping feature to see if you can get it to exclude it.  You can use the MRefBuilder.config found in the PresentationTools folder as an example.  In this case, the namespace would probably be just an empty string (<namespace name="" expose="false" />).  That's just a guess.  I had some problem with the feature and haven't gone back yet to give it a try in the March CTP refresh.

Eric

 





Re: Developer Documentation and Help System HELP: MrefBuilder with /internal+ creates "(Default namespace)"

KidN

Eric,

Thanks for the suggestion. I tried altering the MRefBuilder.exe.config file like this :

<apiFilter expose="true">
<namespace name="" expose="false"/>
</apiFilter>

and I still get that that "( Default namespace )". The only difference is that I no longer get any class or method information under the "(Default Namespace )" node.

Any ideas

KidN




Re: Developer Documentation and Help System HELP: MrefBuilder with /internal+ creates "(Default namespace)"

Anand Raman - MSFT

KidN,

Are you trying to use /Internal+ to document private members . The Boolean /internal option enables documentation of private APIs to be produced for the internal consumption of development teams. Eric is correct and you can set the apiFilter or attributeFilter element, and if it¡¯s not set it defaults to false.

<apiFilter expose=¡±true¡±>

<!-- define exception filters -->

</apiFilter>

Anand..






Re: Developer Documentation and Help System HELP: MrefBuilder with /internal+ creates "(Default namespace)"

KidN

Anand,
Yes. I'm trying to use /internal+ option. This documentation, as you pointed out, is for our internal development team.

I need to document all the private and public methods/events/properties so that we have one document that we can share and use for reviews and training.

For the issue , I have set internal+ option, link type to "MSDN" and have that MRefBuilder.config section as mentioned earlier. I still get that "Default namespace" node.

Anything I'm missing or not understanding correctly

KidN




Re: Developer Documentation and Help System HELP: MrefBuilder with /internal+ creates "(Default namespace)"

Anand Raman - MSFT

I can repro. this and you see a (Default namespace) similar to http://msdn2.microsoft.com/en-us/library/aa388745.aspx.

I am checking on this and will let you know an answer tomorrow.

Anand..






Re: Developer Documentation and Help System HELP: MrefBuilder with /internal+ creates "(Default namespace)"

KidN

Thanks, Eric and Anand, for your valuable suggestions. I will wait for an answer.

KidN




Re: Developer Documentation and Help System HELP: MrefBuilder with /internal+ creates "(Default namespace)"

Anand Raman - MSFT

¡°Default Namespace¡± is the namespace for APIs that have no assigned namespace. You should get it w/o the /internal+ switch if you create public APIs that have no assigned namespace.

If the user doesn¡¯t want a ¡°Default Namespace¡± node then he should make sure all his pubic and private APIs are in a namespace. (He just needs to look under that TOC node to see which APIs are there.)

If that node is showing up even though the namespace is empty, then there is a bug. I am checking on this.

Anand..






Re: Developer Documentation and Help System HELP: MrefBuilder with /internal+ creates "(Default namespace)"

KidN

Anand,
Thanks for your reply.

All my private and public APIs are in a namespace. I still see that "(Default Namespace)" node in TOC and it is empty.

If it is a bug, is there a workaround other than editing reflection.org

KidN.






Re: Developer Documentation and Help System HELP: MrefBuilder with /internal+ creates "(Default namespace)"

Anand Raman - MSFT

Yes and that will be the easiest. I will log a bug and will provide a fix. If we cannot repro. we will ask you additional info.

Anand..






Re: Developer Documentation and Help System HELP: MrefBuilder with /internal+ creates "(Default namespace)"

KidN

Anand,

Thanks. I will wait for the fix.

KidN