Re: Documentation of DLL(.net) in design time - C# Discussion Boards

Ed.Poore20-Jul-06 12:41

20-Jul-06 12:41

You might need them to be referenced as relative paths, I've never had a problem before using images in the workshop. Just lay it out like a simple website (and always use relative paths where possible) and it should be quite happy.

The Welsh will always support two teams: The Welsh, and anyone playing England

_tasleem21-Jul-06 1:06

_tasleem

21-Jul-06 1:06

i made html files through MS word and save as web page, and made the chm file using html workshop but the chm files do not show the images. u mean give the paths in chm file or simple html files.

Tasleem Arif

Ed.Poore21-Jul-06 12:09

21-Jul-06 12:09

I always hand-code the html documents (be it for a website or a help file) so maybe the best example I can give is this:

<html>
	<head>
		<title>Hello World</title>
	</head>
	<body>
		<img src="images/helloworld.png" />
	</body>
</html>

Hope that helps. I don't know how Word references the images.

tasleem143 wrote:
u mean give the paths in chm file or simple html files.

I mean that the paths are relative in the html files. All that the project files for HHW do is define the structure of the TOC and Index and Search words. It then references all the files you want to add and simply compiles them. As far as I know it does not do anything more complex than that. An analogy would be it simply zips all the files with a TOC, Index and Search Keyword file which the HtmlHelp Viewer then unzips and parses the TOC, Index and Search files to produce the listings in the Help Window.

The Welsh will always support two teams: The Welsh, and anyone playing England

Documentation of DLL(.net) in design time

_tasleem21-Jul-06 20:30

_tasleem

21-Jul-06 20:30

thanks it works

Tasleem Arif

mosquets20-Jul-06 9:16

mosquets

20-Jul-06 9:16

I built a library in .net using the xml tags for all the methods like this:
///

/// Apply non linear filters.
///

public void A(){} After I marked the option to generate XML Documentation File in the Project Properties. What do I must to do to include the xml documentation in my class library? My goal is to show all my method comments in a client class of another project. I know that exist some tools to generate the chm with all the documentation but I want to show it in design time, in others words, when I'm using the class library in the IDE as a client. Can you give me some hint?

Thanks you very much,

Marcel

Ed.Poore20-Jul-06 12:37

20-Jul-06 12:37

I'm not 100% sure but I think you just need to make sure that the xml file produced is in the same directory as the dll being referenced by the IDE, i.e. VS will probably make a local copy if it's not in the GAC so the xml doc file needs to be in the bin\Release or bin\Debug directory (sorry you'll have to find out by trial & error or just put it in both).

The Welsh will always support two teams: The Welsh, and anyone playing England

mosquets21-Jul-06 4:11

mosquets

21-Jul-06 4:11

Thanks you very much. I got it. You only must refering to the dll in design time and will appear the comments. After when you build the solution in the client project VS will generate the xml doc file in the bin\Release or bin\Debug directory. I was doing that but I don't refreshed the reference.

Now I want to change the icon to the dll and I know that I can do it setting in
HKEY_CLASSES_ROOT\dllfile\DefaultIcon but for all the dll. Is it possible for this one?

Thanks a lot,

Marcel

Ed.Poore21-Jul-06 12:10

21-Jul-06 12:10

You should be able to just use the properties page in VS to set the icon of the dll. There is no point in using the registry. Just use the same method as you would for a WinForms application.

The Welsh will always support two teams: The Welsh, and anyone playing England

mosquets24-Jul-06 5:01

mosquets

24-Jul-06 5:01

Sorry, I don't understood your explanation because I added in properties of project/resources/icon the the .ico and when I build the solution continue the default image in the dll. Can you explain in more detail?

thanks again,

Ed.Poore24-Jul-06 6:01

convert avi to mp4 in C# or C++

24-Jul-06 6:01

Double Click Properties in Solution Explorer
Goto Application tab
In the Resources group box select "Icon".
Either:
Select the icon (if already in project)
Add the icon to the project by clicking the ... to the right of the combo box.

Formula 1 - Short for "F1 Racing" - named after the standard "help" key in Windows, it's a sport where participants desperately search through software help files trying to find actual documentation. It's tedious and somewhat cruel, most matches ending in a draw as no participant is able to find anything helpful. - Shog⁹

Ed

thyscorpion20-Jul-06 8:57

thyscorpion

20-Jul-06 8:57

hi i was looking for help in making a simple application for myself to convert my divx avi files to mp4 (ipod format)... i know there are a few free softwares available.. but i wanted to improve my programming skills and as i need such a program for myself currently i would be glad if i am helped in how to go about it in C#.NET FM2 or C++...
if someone has a link for such a tutorial or book. plz help me out.
or if someone can guide me throu this i will be more than glad..
thanks. Smile | :)

Ed.Poore20-Jul-06 12:40

20-Jul-06 12:40

As far as I know DivX is a proprietary format so you must use their codecs, there might be some info on their website for interfacing with the dlls. Might be worth checking out their labs: http://labs.divx.com[^].

thyscorpion wrote:
but i wanted to improve my programming skills

IMHO, this is an extremely complex program to write if you're just starting off.

The Welsh will always support two teams: The Welsh, and anyone playing England

thyscorpion20-Jul-06 21:25

thyscorpion

20-Jul-06 21:25

.. yeah i agree its a damn complex thing to start with. thanks for your advise...
still is there any tutorial site or book that will help me achive my goal?
thanks!

Ed.Poore20-Jul-06 21:43

20-Jul-06 21:43

I would think that the best place to start is some of the DivX forums. I don't know of any tutorial sites but will hunt around when I get some free time.