How to do doxygen documentation?
My boss told me do documentation in doxygen. i did google and found you can do codes documentation in doxygen, but what about Details and text documentation which doesn't has codes.
linux documentation
edited Dec 16 at 3:43
Rui F Ribeiro
38.8k1479129
asked Jul 29 '15 at 15:58
Satish
64311134
add a comment |
My boss told me do documentation in doxygen. i did google and found you can do codes documentation in doxygen, but what about Details and text documentation which doesn't has codes.
linux documentation
edited Dec 16 at 3:43
Rui F Ribeiro
38.8k1479129
asked Jul 29 '15 at 15:58
Satish
64311134
What are you documenting ? Can you show us an example ?
– amisax
Jul 29 '15 at 16:06
its simple documents about, how to installXYZapplication, for example lets sayHow to install apache and configure SSL?just need to do that kind of documentation. it has configuration file httpd.conf and ssl.conf how do i put them in doxygen?
– Satish
Jul 29 '15 at 16:13
You will be better off downloading doxygen manual and get an idea on how to document. I do not think you should be using doxygen to write about how to install apache or configure SSL.
– unxnut
Jul 29 '15 at 16:38
add a comment |
My boss told me do documentation in doxygen. i did google and found you can do codes documentation in doxygen, but what about Details and text documentation which doesn't has codes.
linux documentation
edited Dec 16 at 3:43
Rui F Ribeiro
38.8k1479129
asked Jul 29 '15 at 15:58
Satish
64311134
My boss told me do documentation in doxygen. i did google and found you can do codes documentation in doxygen, but what about Details and text documentation which doesn't has codes.
linux documentation
linux documentation
edited Dec 16 at 3:43
Rui F Ribeiro
38.8k1479129
asked Jul 29 '15 at 15:58
Satish
64311134
edited Dec 16 at 3:43
Rui F Ribeiro
38.8k1479129
asked Jul 29 '15 at 15:58
Satish
64311134
edited Dec 16 at 3:43
Rui F Ribeiro
38.8k1479129
edited Dec 16 at 3:43
Rui F Ribeiro
38.8k1479129
edited Dec 16 at 3:43
Rui F Ribeiro
38.8k1479129
38.8k1479129
asked Jul 29 '15 at 15:58
Satish
64311134
asked Jul 29 '15 at 15:58
Satish
64311134
asked Jul 29 '15 at 15:58
Satish
64311134
64311134
What are you documenting ? Can you show us an example ?
– amisax
Jul 29 '15 at 16:06
its simple documents about, how to installXYZapplication, for example lets sayHow to install apache and configure SSL?just need to do that kind of documentation. it has configuration file httpd.conf and ssl.conf how do i put them in doxygen?
– Satish
Jul 29 '15 at 16:13
You will be better off downloading doxygen manual and get an idea on how to document. I do not think you should be using doxygen to write about how to install apache or configure SSL.
– unxnut
Jul 29 '15 at 16:38
add a comment |
What are you documenting ? Can you show us an example ?
– amisax
Jul 29 '15 at 16:06
its simple documents about, how to installXYZapplication, for example lets sayHow to install apache and configure SSL?just need to do that kind of documentation. it has configuration file httpd.conf and ssl.conf how do i put them in doxygen?
– Satish
Jul 29 '15 at 16:13
You will be better off downloading doxygen manual and get an idea on how to document. I do not think you should be using doxygen to write about how to install apache or configure SSL.
– unxnut
Jul 29 '15 at 16:38
What are you documenting ? Can you show us an example ?
– amisax
Jul 29 '15 at 16:06
What are you documenting ? Can you show us an example ?
– amisax
Jul 29 '15 at 16:06
its simple documents about, how to install
XYZ application, for example lets say How to install apache and configure SSL? just need to do that kind of documentation. it has configuration file httpd.conf and ssl.conf how do i put them in doxygen?– Satish
Jul 29 '15 at 16:13
its simple documents about, how to install
XYZ application, for example lets say How to install apache and configure SSL? just need to do that kind of documentation. it has configuration file httpd.conf and ssl.conf how do i put them in doxygen?– Satish
Jul 29 '15 at 16:13
You will be better off downloading doxygen manual and get an idea on how to document. I do not think you should be using doxygen to write about how to install apache or configure SSL.
– unxnut
Jul 29 '15 at 16:38
You will be better off downloading doxygen manual and get an idea on how to document. I do not think you should be using doxygen to write about how to install apache or configure SSL.
– unxnut
Jul 29 '15 at 16:38
add a comment |
1 Answer
1
active
oldest
votes
First, install doxygen (I'm sure your OS distribution has a package). Then, in the top directory of your source tree run:
doxywizard Doxyfile
This gives you an easy way to create a Doxyfile, which is essentially a set of instructions about how you would like doxygen to proceed. I like to configure it to output to a subdirectory like doc/html.
Then put some doxygen comments in your source code. You have to comment the top of the file with something like:
//! file myfile.h This is my header file
And then comment individual symbols with:
//! This is my function:
void function();
There are other syntaxes, described here: http://www.doxygen.nl/manual/docblocks.html#specialblock
Then run:
doxygen
And it will create your documentation. Fire up a web browser.
Oh, and if you want documentation files that don't contain source code, no problem. You can configure doxygen to recognize markdown files that end .md. Just make sure *.md is in your FILE_PATTERNS. You can also set USE_MDFILE_AS_MAINPAGE to a markdown file to create the front page from markdown. These directives are in your Doxyfile, but you can edit them from the wizard as well.
edited 33 mins ago
albert
1091
answered Jul 29 '15 at 18:22
user3188445
2,590826
add a comment |
Your Answer
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "106"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: false,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: null,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2funix.stackexchange.com%2fquestions%2f219077%2fhow-to-do-doxygen-documentation%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
1 Answer
1
active
oldest
votes
1 Answer
1
active
oldest
votes
active
oldest
votes
active
oldest
votes
First, install doxygen (I'm sure your OS distribution has a package). Then, in the top directory of your source tree run:
doxywizard Doxyfile
This gives you an easy way to create a Doxyfile, which is essentially a set of instructions about how you would like doxygen to proceed. I like to configure it to output to a subdirectory like doc/html.
Then put some doxygen comments in your source code. You have to comment the top of the file with something like:
//! file myfile.h This is my header file
And then comment individual symbols with:
//! This is my function:
void function();
There are other syntaxes, described here: http://www.doxygen.nl/manual/docblocks.html#specialblock
Then run:
doxygen
And it will create your documentation. Fire up a web browser.
Oh, and if you want documentation files that don't contain source code, no problem. You can configure doxygen to recognize markdown files that end .md. Just make sure *.md is in your FILE_PATTERNS. You can also set USE_MDFILE_AS_MAINPAGE to a markdown file to create the front page from markdown. These directives are in your Doxyfile, but you can edit them from the wizard as well.
edited 33 mins ago
albert
1091
answered Jul 29 '15 at 18:22
user3188445
2,590826
add a comment |
First, install doxygen (I'm sure your OS distribution has a package). Then, in the top directory of your source tree run:
doxywizard Doxyfile
This gives you an easy way to create a Doxyfile, which is essentially a set of instructions about how you would like doxygen to proceed. I like to configure it to output to a subdirectory like doc/html.
Then put some doxygen comments in your source code. You have to comment the top of the file with something like:
//! file myfile.h This is my header file
And then comment individual symbols with:
//! This is my function:
void function();
There are other syntaxes, described here: http://www.doxygen.nl/manual/docblocks.html#specialblock
Then run:
doxygen
And it will create your documentation. Fire up a web browser.
Oh, and if you want documentation files that don't contain source code, no problem. You can configure doxygen to recognize markdown files that end .md. Just make sure *.md is in your FILE_PATTERNS. You can also set USE_MDFILE_AS_MAINPAGE to a markdown file to create the front page from markdown. These directives are in your Doxyfile, but you can edit them from the wizard as well.
edited 33 mins ago
albert
1091
answered Jul 29 '15 at 18:22
user3188445
2,590826
add a comment |
First, install doxygen (I'm sure your OS distribution has a package). Then, in the top directory of your source tree run:
doxywizard Doxyfile
This gives you an easy way to create a Doxyfile, which is essentially a set of instructions about how you would like doxygen to proceed. I like to configure it to output to a subdirectory like doc/html.
Then put some doxygen comments in your source code. You have to comment the top of the file with something like:
//! file myfile.h This is my header file
And then comment individual symbols with:
//! This is my function:
void function();
There are other syntaxes, described here: http://www.doxygen.nl/manual/docblocks.html#specialblock
Then run:
doxygen
And it will create your documentation. Fire up a web browser.
Oh, and if you want documentation files that don't contain source code, no problem. You can configure doxygen to recognize markdown files that end .md. Just make sure *.md is in your FILE_PATTERNS. You can also set USE_MDFILE_AS_MAINPAGE to a markdown file to create the front page from markdown. These directives are in your Doxyfile, but you can edit them from the wizard as well.
edited 33 mins ago
albert
1091
answered Jul 29 '15 at 18:22
user3188445
2,590826
First, install doxygen (I'm sure your OS distribution has a package). Then, in the top directory of your source tree run:
doxywizard Doxyfile
This gives you an easy way to create a Doxyfile, which is essentially a set of instructions about how you would like doxygen to proceed. I like to configure it to output to a subdirectory like doc/html.
Then put some doxygen comments in your source code. You have to comment the top of the file with something like:
//! file myfile.h This is my header file
And then comment individual symbols with:
//! This is my function:
void function();
There are other syntaxes, described here: http://www.doxygen.nl/manual/docblocks.html#specialblock
Then run:
doxygen
And it will create your documentation. Fire up a web browser.
Oh, and if you want documentation files that don't contain source code, no problem. You can configure doxygen to recognize markdown files that end .md. Just make sure *.md is in your FILE_PATTERNS. You can also set USE_MDFILE_AS_MAINPAGE to a markdown file to create the front page from markdown. These directives are in your Doxyfile, but you can edit them from the wizard as well.
edited 33 mins ago
albert
1091
answered Jul 29 '15 at 18:22
user3188445
2,590826
edited 33 mins ago
albert
1091
edited 33 mins ago
albert
1091
edited 33 mins ago
albert
1091
1091
answered Jul 29 '15 at 18:22
user3188445
2,590826
answered Jul 29 '15 at 18:22
user3188445
2,590826
answered Jul 29 '15 at 18:22
user3188445
2,590826
2,590826
add a comment |
add a comment |
Thanks for contributing an answer to Unix & Linux Stack Exchange!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Some of your past answers have not been well-received, and you're in danger of being blocked from answering.
Please pay close attention to the following guidance:
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2funix.stackexchange.com%2fquestions%2f219077%2fhow-to-do-doxygen-documentation%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
What are you documenting ? Can you show us an example ?
– amisax
Jul 29 '15 at 16:06
its simple documents about, how to install
XYZapplication, for example lets sayHow to install apache and configure SSL?just need to do that kind of documentation. it has configuration file httpd.conf and ssl.conf how do i put them in doxygen?– Satish
Jul 29 '15 at 16:13
You will be better off downloading doxygen manual and get an idea on how to document. I do not think you should be using doxygen to write about how to install apache or configure SSL.
– unxnut
Jul 29 '15 at 16:38