Skip to content

Conversation

GMishx
Copy link
Member

@GMishx GMishx commented May 14, 2018

Changes

  1. Created Doxygen configuration file (fossolog_doxygen.conf) required to create doxygen documents.
  2. Changes comments on source pages as per the doxygen format.

Current documentation: https://gmishx.github.io/ (updated on every commit).

@GMishx GMishx force-pushed the docs/doxygensupport branch from af9be67 to f381001 Compare May 15, 2018 08:02
@ghost ghost assigned GMishx May 15, 2018
@GMishx GMishx force-pushed the docs/doxygensupport branch 3 times, most recently from 4b96911 to 708b8c4 Compare May 17, 2018 11:32
@GMishx GMishx force-pushed the docs/doxygensupport branch from 1f5b119 to e1dffb2 Compare June 1, 2018 10:11
@ghost ghost removed the WIP label Jun 18, 2018
@GMishx GMishx force-pushed the docs/doxygensupport branch 2 times, most recently from 45f31ae to 75c267e Compare June 18, 2018 09:38
@GMishx GMishx added the WIP label Jun 18, 2018
@ghost ghost removed the WIP label Jun 18, 2018
@GMishx GMishx changed the title docs(doxygen): Add doxygen conf file docs(doxygen): Add doxygen conf file and documentations Jun 19, 2018
@GMishx GMishx force-pushed the docs/doxygensupport branch from 1ed9205 to 18b4ff3 Compare June 20, 2018 07:54
@mcjaeger mcjaeger added the has merge conflicts PR to be rebased label Jun 22, 2018
@GMishx GMishx changed the title docs(doxygen): Add doxygen conf file and documentations WIP: docs(doxygen): Add doxygen conf file and documentations Jun 22, 2018
@GMishx GMishx force-pushed the docs/doxygensupport branch from 01564c1 to 391a747 Compare June 25, 2018 08:43
@GMishx GMishx removed the has merge conflicts PR to be rebased label Jun 25, 2018
@mcjaeger mcjaeger added the WIP label Jul 10, 2018
@mcjaeger mcjaeger assigned mcjaeger and unassigned GMishx Jul 24, 2018
@GMishx GMishx force-pushed the docs/doxygensupport branch from 58ee62e to 85276f8 Compare August 6, 2018 06:00
@ghost ghost assigned GMishx Aug 6, 2018
@GMishx GMishx changed the title WIP: docs(doxygen): Add doxygen conf file and documentations docs(doxygen): Add doxygen conf file and documentations Aug 20, 2018
@GMishx GMishx added the has merge conflicts PR to be rebased label Aug 20, 2018
@GMishx GMishx force-pushed the docs/doxygensupport branch from 85276f8 to f024400 Compare August 20, 2018 15:13
@GMishx GMishx removed WIP has merge conflicts PR to be rebased labels Aug 20, 2018
@GMishx GMishx force-pushed the docs/doxygensupport branch from f024400 to 6c2564f Compare August 21, 2018 05:20
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]>
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]>
@GMishx GMishx force-pushed the docs/doxygensupport branch from 3661d34 to adc9117 Compare September 18, 2018 07:36
@ghost ghost assigned GMishx Sep 18, 2018
@GMishx GMishx removed their assignment Sep 18, 2018
#define FUNCTION

/**
* Maximum buffer to use
Copy link
Member

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 |
Copy link
Member

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
Copy link
Member

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;

/**
Copy link
Member

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
Copy link
Member

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!

Copy link
Member Author

@GMishx GMishx Sep 24, 2018

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

uuhhh, second one!

Copy link
Member Author

@GMishx GMishx Sep 24, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mcjaeger
Copy link
Member

@maxhbr sorry for overriding, hope it is OK, since lic header is added.

Copy link
Member

@mcjaeger mcjaeger left a 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.

@mcjaeger
Copy link
Member

tested-by:[email protected] - was testing if the fossology works in vagrant actually, and looked at doxy web pages.

@mcjaeger mcjaeger merged commit e6af03e into fossology:master Sep 21, 2018
@ghost ghost removed the needs code review label Sep 21, 2018
@GMishx GMishx deleted the docs/doxygensupport branch September 24, 2018 03:58
@GMishx
Copy link
Member Author

GMishx commented Sep 24, 2018

Pushed the HTMLs to https://fossology.github.io/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants