documentation-generation

Creating Documentation from VB Script Code [closed]

阅读更多关于 Creating Documentation from VB Script Code [closed]

问题 Closed. This question is off-topic. It is not currently accepting answers. Want to improve this question? Update the question so it's on-topic for Stack Overflow. Closed last year . We have a large framework created using VB Script, which has been created and then maintained for the past few years. This code was initially well documented and all the initial functions and variables and files had good headers in them. Later in maintainence, the code got obfuscated by the coders not keeping

(Python-Sphinx) How to generate HTML Documentation?

阅读更多关于 (Python-Sphinx) How to generate HTML Documentation?

问题 I'm working on a Python project using PyCharm and now I need to generate the corresponding API documentation. I'm documenting the code methods and classes using docstrings . I read about Sphinx and Doxygen, with Sphinx being the most recommended right now. I tried to configure Sphinx whitin PyCharm but I had no luck in getting it working. This is the project structure : and this was the I/O interaction with the command Sphinx Quickstart C:\Python\Python36\Scripts\sphinx-quickstart.exe Welcome

Using Sphinx docs how can I specify png image formats for HTML builds and pdf image formats for Latex/PDF builds?

阅读更多关于 Using Sphinx docs how can I specify png image formats for HTML builds and pdf image formats for Latex/PDF builds?

问题 Using sphinx doc generator, I am trying to use .png images for the HTML builds of the documentation, and then I want to have the .svg images used for the PDF/LATEx builds. Anyone know how to "tag" sections as "HTML build"-only and "Latex build"-only? Cheers 回答1: Take a look at these options: Image filename wildcard: .. image:: gnu.* From the documentation: "For instance, if the file name gnu.* was given and two files gnu.pdf and gnu.png existed in the source tree, the LaTeX builder would

Can sphinx napoleon document function returning multiple arguments?

阅读更多关于 Can sphinx napoleon document function returning multiple arguments?

问题 I am trying to use the Google code style to document a function that I then use sphinx with the napoleon extension to create documentation for. The function is unusual in that is returns two arguments. I don't think napoleon handles this. If so, could someone tell me how they handle it? def foo(a): '''one line summary longer explanation Args: a (int): parameter description Returns: servers (list): list of servers to use msg (str): logging message string ''' pass Maybe I'm getting a message

Using Doxygen with C, do you comment the function prototype or the definition? Or both?

阅读更多关于 Using Doxygen with C, do you comment the function prototype or the definition? Or both?

问题 I'm using Doxygen with some embedded C source. Given a .c/.h file pair, do you put Doxygen comments on the function prototype (.h file) or the function definition (.c file), or do you duplicate them in both places? I'm having a problem in which Doxygen is warning about missing comments when I document in one place but not the other; is this expected, or is my Doxygen screwed up? 回答1: For public APIs I document at the declaration, as this is where the user usually looks first if not using the

Swagger With Static Documentation

阅读更多关于 Swagger With Static Documentation

问题 I am looking to use Swagger to document my restful interface. The problem is that I do not want to automatically generate my documentation by annotating my code. Basically I don't want to couple my internal data model to the virtual data model exposed by the interface. It appears that I can just have my server provide a Resources.json file and then a corresponding JSON file for each resource handler. However, when I tried this I ran into lots of little gotchas while attempting to define the

How to create documentation for instance variable and methods in Xcode?

阅读更多关于 How to create documentation for instance variable and methods in Xcode?

I'd like to be able to Alt-Click an instance variable (or a method) as part of the program i created and read what it's purpose is. The fact that Xcode is telling me the class variable is declared at - is nice but not enough. In this case i'd like to see custom text i typed to describe what an asset really is. Additionally type of the ivar would also be useful to know. How can this be done? In this case, i wonder what exactly did i mean by assets I specifically wonder if this information can be viewed from inside Xcode , similar to how Eclipse shows JavaDoc content. You would need to create a

Using Sphinx docs how can I specify png image formats for HTML builds and pdf image formats for Latex/PDF builds?

阅读更多关于 Using Sphinx docs how can I specify png image formats for HTML builds and pdf image formats for Latex/PDF builds?

Using sphinx doc generator, I am trying to use .png images for the HTML builds of the documentation, and then I want to have the .svg images used for the PDF/LATEx builds. Anyone know how to "tag" sections as "HTML build"-only and "Latex build"-only? Cheers Take a look at these options: Image filename wildcard: .. image:: gnu.* From the documentation : "For instance, if the file name gnu.* was given and two files gnu.pdf and gnu.png existed in the source tree, the LaTeX builder would choose the former, while the HTML builder would prefer the latter." The only directive: .. only:: latex This

Using Doxygen with C, do you comment the function prototype or the definition? Or both?

阅读更多关于 Using Doxygen with C, do you comment the function prototype or the definition? Or both?

I'm using Doxygen with some embedded C source. Given a .c/.h file pair, do you put Doxygen comments on the function prototype (.h file) or the function definition (.c file), or do you duplicate them in both places? I'm having a problem in which Doxygen is warning about missing comments when I document in one place but not the other; is this expected, or is my Doxygen screwed up? gimpf For public APIs I document at the declaration, as this is where the user usually looks first if not using the doxygen output. I never had problems with only documenting on one place only, but I used it with C++;

Anything better than PHPDoc out there? [closed]

阅读更多关于 Anything better than PHPDoc out there? [closed]

Does anybody use anything else to document their PHP code than PHPDoc? Are there any tools that read the same documentation syntax but give richer output? I´ll go for doxygen too. Here are several reasons : compatible with phpdoc tags and other popular ones : it´s interoperable works with various programming languages : a better time investment there is alternative syntaxes : can choose the commenting style that suit you very efficient with advanced formating / tagging / metadata there is a GUI that is not linked to any IDE and an eclipse plugin as well And still free, multiplatform, and open