documentation

How to specify image size in HTML Doxygen?

 ̄綄美尐妖づ 提交于 2019-11-29 01:27:05
I am trying to manually specify the image size in the HTML generated by Doxygen. However, as I read in the documentation , this can only happen if using LaTeX output. Anybody here knows any workaround? As an example, I would like to do something like this: \image html example.png "Caption" width=10px Thank you! Put this in the CSS file "Doc/doxygen_html_style.css": div.image img[src="example.png"]{ width:100px; } And set the Doxygen config variable *HTML_EXTRA_STYLESHEET* to "Doc/doxygen_html_style.css" To avoid resorting to an extra CSS style sheet you can directly inline the CSS code:

Is there a command line C++ to PDF converter with syntax highlighting? [closed]

别来无恙 提交于 2019-11-29 01:04:00
问题 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 . I need to supply "Source code documents w/ Line numbers" which is essentially just a PDF of the source code with syntax highlighting and Line numbers. Is there any existing command line tools for windows that I could call from a script as a "build release version" script? Right now I'm doing it manually using VC++

Getting developers to use a wiki [closed]

杀马特。学长 韩版系。学妹 提交于 2019-11-29 00:59:49
问题 I work on a complex application where different teams work on their own modules with a degree of overlap. A while back we got a Mediawiki instance set up, partly at my prompting. I have a hard job getting people to actually use it, let alone contribute. I can see a lot of benefit in sharing information. It may at least reduce the times we reinvent the wheel. The wiki is not very structured, but I'm not sure that is a problem as long as you can search for what you need. Any hints? 回答1: As I

C/C++ Header file documentation [closed]

你离开我真会死。 提交于 2019-11-29 00:31:00
问题 What do you think is best practice when creating public header files in C++? Should header files contain no, brief or massive documentation? I've seen everything from almost no documentation (relying on some external documentation) to large specifications of invariants, valid parameters, return values etc. I'm not sure exactly what I prefer, large documentation is nice since you've always access to it from your editor, on the other hand a header file with very brief documentation can often

How do I set the language for the Android developer website? [closed]

雨燕双飞 提交于 2019-11-28 23:30:07
问题 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 . When I attempt to navigate to the Android developer website, I am redirected to a version of it much of which is in Chinese. For instance, if I try to navigate to: developer.android.com I am redirected to: http://developer.android.com/intl/zh-cn/index.html I want the English language site. In some cases, I've had

Anything better than PHPDoc out there? [closed]

末鹿安然 提交于 2019-11-28 22:29:26
问题 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 4 years ago . 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? 回答1: I´ll go for doxygen too. Here are several reasons : compatible with phpdoc tags and other popular ones : it´s interoperable works with various

XCode 4.3 Command Line Tools [closed]

谁都会走 提交于 2019-11-28 21:15:53
Apple has recently released Command Line Tools : What are the tools provided in the Command Line Tools package? Is there some sort of documentation other than man pages? Please note that I have installed these tools by adding the specific component in Xcode. Also, this is not about a Xcode project, but a package released by Apple on February 16, 2012! Open the command line tools DMG and you'll find a meta-package, which you can extract with the command pkgutil --expand 'Command Line Tools.mpkg' metapackage . Open the metapackage/Distribution file that was just extracted in a text editor to see

What's a good example for class inheritance? [closed]

走远了吗. 提交于 2019-11-28 21:10:11
I'm writing documentation for an object-oriented language, and I wonder what kind of classes would be a good example for inheritance. Some common examples: class Person { } class Employee extends Person { } Currently my favorite, but I don't like Person->Employee because 'Employee' does not exactly look like fun. class Bicycle { } class MountainBike extends Bicycle { } I found this in some Java tutorial , but it's not really obvious what attributes a bike should have. class Animal { } class Bird extends Animal { } Same as the bicycle. class A { } class B extends A { } Too abstract. The main

how to show instance attributes in sphinx doc?

戏子无情 提交于 2019-11-28 21:05:40
Is there any way how to automaticaly show variables var1 and var2 and their init-values in sphinx documentation? class MyClass: """ Description for class """ def __init__(self, par1, par2): self.var1 = par1 * 2 self.var2 = par2 * 2 def method(self): pass mzjn Your variables are instance variables, not class variables. Without attaching a docstring (or a #: "doc comment") to the variables, they won't be documented. You could do as follows: class MyClass(object): """ Description for class """ def __init__(self, par1, par2): self.var1 = par1 #: initial value: par1 self.var2 = par2 #: initial

How to integrate examples with Doxygen? [closed]

末鹿安然 提交于 2019-11-28 21:04:49
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? Loebl 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 then generate an extra page containing the source of the example. It will also set a link to it from the class documentation containing the example tag. Alternatively if you want to use small code snippets you can insert them with @code ... @endcode The documentation for this is here: doxygen documentation ?