From: Dimitri Papadopoulos-O. <dim...@ce...> - 2006-05-10 07:21:44
|
Hi, Earnie Boyd wrote: >> So the explanations have to be put in the ChangeLog. Unless... Since >> GCC 4 supports precompiled headers, would it be possible to add some >> minimal comments in the header files? I was thinking of a mere link to >> the relevant documentation, something like: >> //http://msdn.microsoft.com/library/.../directshowstructures.asp >> [...] > In theory this sounds good but in practice it will quickly become a > nightmare. MSDN changes its URL references so that you have to continue > to search for the documentation. It isn't feasible in the case of > w32api documentation. OK, the URLs may change but the overall structure of the documentation can't change that often. What if I add the title of the page in addition to / instead of its URL? Something like: //Microsoft DirectShow 9.0 - DirectShow Structures or: //Microsoft DirectShow 9.0 - DirectShow Structures //http://msdn.microsoft.com/library/.../directshowstructures.asp How often do the URLs change? If they change once in a few years, then I think it's still useful to add the URLs. URLs that have not been valid for months may be a sign that the relevant header needs to be updated... Dimitri Papadopoulos |