Qt (B3) Qt and doxygen

Published on| July 9th, 2009 | No Comment.

Categories:Qt |

Did you disable Javascript with your web browser ?
If you disabled it, you will not be able to see any letters of content, or you will not be able to search this site, or you will not be able to send comment.

Create help from project file(.qhp) to .qch file by doxygen

in doxygen, QtAssistant used in the HELP file in the config where you can automatically create a document with the normal procedure to add the following information in the file.

Parameter name	Commentary
GENERATE_QHP	HELP Specifies whether to create a project file. Cases) YES
QHP_NAMESPACE	HELP specifies the namespace of the project. Cases) qthelpName
QHP_VIRTUAL_FOLDER	HELP specify virtual directory name used in the project. Cases) qthelpFolder
QHP_CUST_FILTER_NAME	HELP custom filters to specify the name of the project. Cases) sample
QHP_CUST_FILTER_ATTRS	HELP attribute values specified in the list of custom filter project. See also: Articles: Qt (8) -2 QtAssistant use in creating a file HELP
QHP_SECT_FILTER_ATTRS	Project HELP section of the filter (filter defined) specified in the list of attribute values. See also: Articles: Qt (8) -2 QtAssistant use in creating a file HELP
QCH_FILE	Specify the name of the project file HELP. If anything, index.qhp.
QHG_LOCATION	Qt Help Generator command specifies the image. Example) "qhelpgenerator"

You should be aware of the above parameters, QtHELP can create the file.
This, diagramsQt.cfg then save the file. Below are the contents. This is a simple text file.

[diagrams.cfg]

PROJECT_NAME       = "Diagrams"
OUTPUT_DIRECTORY   = diagramsQt
HAVE_DOT           = YES
EXTRACT_ALL        = YES
GENERATE_LATEX     = NO
GENERATE_MAN       = NO
GENERATE_RTF       = NO
CASE_SENSE_NAMES = NO
ENABLE_PREPROCESSING       = YES
INPUT              = .
FILE_PATTERNS      = diagrams_*.h
QUIET              = YES
#JAVADOC_AUTOBRIEF = YES
QT_AUTOBRIEF      = YES
EXTRACT_PRIVATE        = YES
 
# GENERATE_QHP=YES --> QHP_VIRTUAL_FOLDER=xxx,QHP_NAMESPACE=yyy
GENERATE_QHP           = YES
QHP_NAMESPACE          = qthelpName
QHP_VIRTUAL_FOLDER     = qthelpFolder
QHP_CUST_FILTER_NAME   = sample
QHP_CUST_FILTER_ATTRS  = 
QHP_SECT_FILTER_ATTRS  = 
 
# need set of QHG_LOCATION
QCH_FILE               = 
QHG_LOCATION           = "qhelpgenerator"

Create a document with doxygen

As described in the above, you can create a document by typing the following command.

%diagramsQt.cfg Directory%> doxygen diagramsQt.cfg
%diagramsQt.cfg Directory%>

It is the same. Just specify the file name.
When complete, the logical path of the config file as html and diagrams to be created directory.
Also, this, html Besides, qch I have created the directory.
This, QtHELP This is the directory where the file was created.
This is the project name. Qch (Diagrams.qch), you should have created a file named.

If you have not created any of the above parameters are incorrect and, qhelpgenerator Let's see if the path is set.

So, let's review the contents Diagrams.qch.
Start the QtAssistant normal.

% Qt installation directory% \ bin \ assistant.exe

Double-click Start.

QtAssistant to add the destination Diagrams.qch.

Custom filter, config file "QHP_CUST_FILTER_NAME = sample" has been specified, "Sample" it should be. Let's switch.

Content tree in the left "Diagrams" and I was shown. Let's click.
The right to screen, doxygen screen I created.

This doxygen is used to create your own library and the Qt QtAssistant will provide additional help.
Per this, VisualStudio I feel the same HTML that can be added to help.

Here, Qt was related to the introduction only, doxygen is introduced in addition to this feature, there are a lot of features. I think a good many will be tested.
In the sample, UML (class) example of output parameters to the figures (diagramsU.cfg) are included so, please help.

Pages: 1 2

Comments

Site Description

This site is support & information site of WEB,and Software. This site might help you that create software or Web Site…perhaps?[:]

Qt (B3) Qt and doxygen

You might also like:

Comments

Recent Posts

Contents

Site Description