documentation

Generate html documentation automatically during a build with Sandcastle

由 痞子三分冷 提交于 2019-11-27 13:53:48
问题 What steps do I need to take to get HTML documentation automatically building via the build step in Visual Studio? I have all the comments in place and the comments.xml file being generated, and Sandcastle installed. I just need to know what to add to the post-build step in order to generate the docs. 回答1: Some changes have been made since this question was asked. Sandcastle no longer includes SandcastleBuilderConsole.exe . Instead it uses plain old MSBuild.exe . To integrate this with visual

How to integrate examples with Doxygen? [closed]

由 谁都会走 提交于 2019-11-27 13:27:14
问题 Closed . This question needs to be more focused. It is not currently accepting answers. Want to improve this question? Update the question so it focuses on one problem only by editing this post. Closed last year . I documented all of my classes and now I want to integrate an example of how to use these classes. How do I do that? 回答1: You can put example source code in a special path defined in the doxygen config under EXAMPLE_PATH , and then insert examples with the @example tag. Doxygen will

Comprehensive tutorial on Pyinstaller? [closed]

由 不打扰是莪最后的温柔 提交于 2019-11-27 12:03:55
I'm looking for a tutorial on PyInstaller that will explain things like how to create .pkg files how to include/exclude modules how to include data files inside the install directory. I cannot make much sense out of the standard PyInstaller documentation . Both guides in the accepted answer seem outdated. PyInstaller now provides an executable script that allows you to do pyinstaller your_script.py wherever your_script.py is located -- instead of the old mode of copying your your_script.py to wherever you copied the source code of PyInstaller. Here's a brief, more recent guide that walks you

Does Microsoft SkyDrive have an API? [closed]

由 纵然是瞬间 提交于 2019-11-27 12:03:14
So with the recent news that Microsoft Skydrive is going to get bumped to 25GB of storage per account, does anyone know if SkyDrive has an API? (And if so, where are the docs?) Dare Obasanjo SkyDrive (renamed 'OneDrive') has an official API. Details can be found by going to The OneDrive Developer center . You can also find code samples for working with the OneDrive API, along with source code for the SDKs, on GitHub 来源： https://stackoverflow.com/questions/307696/does-microsoft-skydrive-have-an-api

Programmatically get Summary comments at runtime

由 谁说胖子不能爱 提交于 2019-11-27 11:46:18
I'm looking for a way to programmatically get the summary portion of Xml-comments of a method in ASP.net. I have looked at the previous related posts and they do not supply a way of doing so in a web environment. I can not use any 3rd party apps and due to a web environment, Visual studio plugin's aren't much use either. The closest thing I have found to a working solution was the JimBlackler project, but it only works on DLL's. Naturally, something like 'supply .CS file, get XML documentation' would be optimal. Current situation I have a web-service and trying to dynamically generate

What's the best way to document Perl code? [closed]

由 非 Y 不嫁゛ 提交于 2019-11-27 11:35:41
问题 Closed . This question is opinion-based. It is not currently accepting answers. Want to improve this question? Update the question so it can be answered with facts and citations by editing this post. Closed 6 years ago . Any suggestion how I can document my Perl code? What do you use and what tools are available to help me? Which module do you use to convert pod to html? 回答1: Look inside almost any Perl module and you'll see the Plain Old Documentation (POD) format. On CPAN Search, when

How to properly write cross-references to external documentation with intersphinx?

由 有些话、适合烂在心里 提交于 2019-11-27 10:54:35
问题 I'm trying to add cross-references to external API into my documentation but I'm facing three different behaviors. I am using sphinx(1.3.1) with Python(2.7.3) and my intersphinx mapping is configured as: { 'python': ('https://docs.python.org/2.7', None), 'numpy': ('http://docs.scipy.org/doc/numpy/', None), 'cv2' : ('http://docs.opencv.org/2.4/', None), 'h5py' : ('http://docs.h5py.org/en/latest/', None) } I have no trouble writing a cross-reference to numpy API with :class:`numpy.ndarray` or

A tool to add and complete PHP source code documentation [closed]

由 北战南征 提交于 2019-11-27 10:48:53
I have several finished, older PHP projects with a lot of includes that I would like to document in javadoc/phpDocumentor style. While working through each file manually and being forced to do a code review alongside the documenting would be the best thing, I am, simply out of time constraints, interested in tools to help me automate the task as much as possible. The tool I am thinking about would ideally have the following features: Parse a PHP project tree and tell me where there are undocumented files, classes, and functions/methods (i.e. elements missing the appropriate docblock comment)

Web Api Help Page XML comments from more than 1 files

由 北战南征 提交于 2019-11-27 10:48:36
问题 I have different plugins in my Web api project with their own XML docs, and have one centralized Help page, but the problem is that Web Api's default Help Page only supports single documentation file new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/Documentation.xml")) How is it possible to load config from different files? I wan to do sth like this: new XmlDocumentationProvider("PluginsFolder/*.xml") 回答1: You can modify the installed XmlDocumentationProvider at

.NET xml docs - inheriting documentation

由 那年仲夏 提交于 2019-11-27 10:46:47
问题 NDoc has an XML element inheritdoc which allows you to inherit documentation of a member from the parent class (or an implemented interface). However, Visual Studio (i.e. the C# compiler) does not understand this tag and complains about the documentation not being present or complete. So does StyleCop and some other tools. Is there an alternative approach? How do you go about keeping the docs complete, yet without duplicating the XML descriptions? 回答1: One alternative is to use GhostDoc - an
订阅 documentation