[EMAIL PROTECTED]">nsIScriptContext.h, ironically not an IDL file, in dom/public, has reasonable doc comments.
Brendan Eich wrote:...
How about doc comments for doxygen and future javadoc-style comment
extraction goodness.
Can I get some pointers to good examples to emulate?
The attached list of .idl files all contain /** ... */ comments and @ signs, and some even have reasonable doc comments. Ugh. When in doubt, consult the javadoc link at the http://unstable.elemental.com/mozilla/ site.
/be
caps/idl/nsIScriptSecurityManager.idl docshell/base/nsIDocShell.idl docshell/base/nsIDocShellTreeOwner.idl docshell/base/nsIScrollable.idl docshell/base/nsITextScroll.idl docshell/base/nsIWebNavigation.idl editor/idl/nsIEditorShell.idl editor/idl/nsIPlaintextEditor.idl editor/txmgr/idl/nsITransactionDescription.idl embedding/browser/webBrowser/nsIWebBrowserChrome.idl embedding/browser/webBrowser/nsIWebBrowser.idl extensions/transformiix/public/nsISyncLoader.idl extensions/transformiix/public/nsIXPathNodeSelector.idl extensions/xml-rpc/idl/nsIDictionary.idl extensions/xml-rpc/idl/nsIXmlRpcClient.idl extensions/xml-rpc/idl/nsIXmlRpcClientListener.idl extensions/xmlterm/base/mozILineTerm.idl extensions/xmlterm/base/mozIXMLTermShell.idl gfx/idl/nsIFontEnumerator.idl gfx/idl/nsIScriptableRegion.idl intl/strres/public/nsIStringBundle.idl layout/base/public/nsIDiskDocument.idl layout/base/public/nsISelectionController.idl mailnews/base/public/nsIMsgFolder.idl mailnews/compose/public/nsIMsgSendListener.idl mailnews/compose/public/nsISmtpService.idl modules/libjar/nsIZipReader.idl modules/libpref/public/nsIPrefBranch.idl modules/libpref/public/nsIPref.idl modules/libpref/public/nsIPrefListener.idl modules/plugin/public/nsICookieStorage.idl modules/plugin/public/nsIEventHandler.idl modules/plugin/public/nsILiveConnectPlugin.idl modules/plugin/public/nsIPluginInstance.idl modules/plugin/public/nsIPluginInstancePeer.idl modules/plugin/public/nsIPluginManager2.idl modules/plugin/public/nsIPluginManager.idl modules/plugin/public/nsIPluginManagerMac.idl modules/plugin/public/nsIPluginStreamListener.idl modules/plugin/public/nsIPluginTagInfo2.idl modules/plugin/public/nsIPluginTagInfo.idl netwerk/base/public/nsIAuthenticator.idl netwerk/base/public/nsIChannel.idl netwerk/base/public/nsIIOService.idl netwerk/base/public/nsIProgressEventSink.idl netwerk/base/public/nsIPrompt.idl netwerk/base/public/nsIProtocolHandler.idl netwerk/base/public/nsISocketTransport.idl netwerk/base/public/nsIStreamListener.idl netwerk/base/public/nsIStreamObserver.idl netwerk/core/public/nsIInputStream2.idl netwerk/core/public/nsIOutputStream2.idl netwerk/streamconv/public/mozITXTToHTMLConv.idl netwerk/streamconv/public/nsIStreamConverter.idl netwerk/streamconv/public/nsIStreamConverterService.idl netwerk/streamconv/public/nsITXTToHTMLConv.idl rdf/base/idl/nsIControllerCommand.idl rdf/base/idl/nsIRDFCompositeDataSource.idl rdf/base/idl/nsIRDFContainer.idl rdf/base/idl/nsIRDFDataSource.idl rdf/base/idl/nsIRDFObserver.idl rdf/base/idl/nsIRDFRemoteDataSource.idl rdf/base/idl/nsIRDFXMLSink.idl rdf/base/idl/nsIXULSortService.idl rdf/chrome/public/nsIChromeRegistry.idl uriloader/base/nsIWebProgress.idl uriloader/base/nsIWebProgressListener.idl webshell/public/nsIRefreshURI.idl widget/public/nsIAppShell.idl widget/public/nsIBaseWindow.idl widget/public/nsIClipboard.idl widget/public/nsIClipboardOwner.idl widget/public/nsIDragService.idl widget/public/nsIDragSession.idl widget/public/nsIFilePicker.idl widget/public/nsIFormatConverter.idl widget/public/nsIToolkit.idl widget/public/nsITransferable.idl widget/public/nsIWidget.idl xpcom/appshell/nativeApp/nsINativeApp.idl xpcom/base/nsILoggingService.idl xpcom/base/nsIMemory.idl xpcom/components/nsICategoryHandler.idl xpcom/components/nsICategoryManager.idl xpcom/components/nsIComponentManager.idl xpcom/ds/nsIPersistentProperties2.idl xpcom/ds/nsIProperties.idl xpcom/ds/nsIStopwatch.idl xpcom/ds/nsISupportsIterators.idl xpcom/io/nsIBufferInputStream.idl xpcom/io/nsIBufferOutputStream.idl xpcom/io/nsIFile.idl xpcom/io/nsIInputStream.idl xpcom/io/nsILocalFile.idl xpcom/io/nsIOutputStream.idl xpcom/io/nsIScriptableInputStream.idl xpcom/threads/nsIEventQueueService.idl xpfe/appshell/public/nsIAppShellService.idl xpfe/appshell/public/nsICommonDialogs.idl xpfe/appshell/public/nsIXULWindow.idl
