-
Notifications
You must be signed in to change notification settings - Fork 483
docs(doxygen): Add doxygen conf file and documentations #1098
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
af9be67
to
f381001
Compare
4b96911
to
708b8c4
Compare
1f5b119
to
e1dffb2
Compare
45f31ae
to
75c267e
Compare
1ed9205
to
18b4ff3
Compare
01564c1
to
391a747
Compare
58ee62e
to
85276f8
Compare
85276f8
to
f024400
Compare
f024400
to
6c2564f
Compare
Signed-off-by: Gaurav Mishra <[email protected]>
Signed-off-by: Gaurav Mishra <[email protected]>
Signed-off-by: Gaurav Mishra <[email protected]>
fix(mimetype): Doxygen content changed mimetype of mimetype.c, changed the file to be tested to Makefile for consistent results. Signed-off-by: Gaurav Mishra <[email protected]>
fix(doxygen.conf): Excluded SPDX test files docs(readmeoss): Added a TODO docs(copyright): Added a \test Signed-off-by: Gaurav Mishra <[email protected]>
Signed-off-by: Gaurav Mishra <[email protected]>
fix(reuser): Removed symoblic link reuser Signed-off-by: Gaurav Mishra <[email protected]>
Files removed: fix(test_TraverseUnunpackEntry.c): A unit test file sitting in Functional test folder for a functionality which does not exists anymore. fix(unpackTest.php): Unit test cases for Copyright agent added here. Signed-off-by: Gaurav Mishra <[email protected]>
Included text from README.md to dox.c for better control over formatting. Removed README.md from doxygen scanner. Change in Agent structure. Signed-off-by: Gaurav Mishra <[email protected]>
Signed-off-by: Gaurav Mishra <[email protected]>
Signed-off-by: Gaurav Mishra <[email protected]>
Signed-off-by: Gaurav Mishra <[email protected]>
Signed-off-by: Gaurav Mishra <[email protected]>
Signed-off-by: Gaurav Mishra <[email protected]>
3661d34
to
adc9117
Compare
#define FUNCTION | ||
|
||
/** | ||
* Maximum buffer to use |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
actually, ok, but not so much informative. I understand that there is not more information currently, but ...
* application/x-empty :: zero-length file | ||
* text/plain :: 1st 100 characters are printable | ||
* application/octet-stream :: 1st 100 characters contain binary | ||
* | Mimetype | Description | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fancy!
/* ************************************************************************** */ | ||
|
||
/* | ||
* The following macro definitions are meant to act as their own statement in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice catches
@@ -18,16 +18,24 @@ | |||
|
|||
use Fossology\Lib\Plugin\AgentPlugin; | |||
|
|||
/** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe it is not "multiple"
* @brief find partition | ||
* \brief find partition file | ||
* \test | ||
* -# Call FindCmd() on parition file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
finally! found a spelling mistake!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@@ -55,7 +64,10 @@ void testTraverseStartNormal() | |||
} | |||
|
|||
/** | |||
* @brief test traversestart dirctory | |||
* @brief test TraverseStart() dirctory |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
uuhhh, second one!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@maxhbr sorry for overriding, hope it is OK, since lic header is added. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
minor issues found (see code comments), but not preventing merging.
tested-by:[email protected] - was testing if the fossology works in vagrant actually, and looked at doxy web pages. |
Pushed the HTMLs to https://fossology.github.io/ |
Changes
fossolog_doxygen.conf
) required to create doxygen documents.Current documentation: https://gmishx.github.io/ (updated on every commit).