Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[Jenkins] Ignore some warnings in Docs job. #1585

Merged
merged 5 commits into from
Nov 29, 2016
Merged

[Jenkins] Ignore some warnings in Docs job. #1585

merged 5 commits into from
Nov 29, 2016

Conversation

bilke
Copy link
Member

@bilke bilke commented Nov 28, 2016 •
edited
Loading

12 warnings left ...

There were no warnings concerning max graph ...

@endJunction
Copy link
Member

I'll look into the remaining warnings.

@endJunction
Copy link
Member

@bilke Could it be that perl is not installed on dockers?
Problems running bibtex. Verify that the command 'perl --version' works from the command line. Exit code: 2

@endJunction
Copy link
Member

endJunction commented Nov 28, 2016 •
edited
Loading

The cite warnings are due to some errors in Doxygen. The bibliography generation works fine with 1.8.12 version.

The known problem of wrong link generation for cite is not fixed in 1.8.11.

So either upgrade or add \cite command to .* does not have an associated number to the ignore list.

@endJunction
Copy link
Member

@rinkk Could you please add documentation to 'window' parameter here:
DiagramPrefsDialog.h:69

The following parameters of DiagramPrefsDialog::DiagramPrefsDialog(const QString &filename, DetailWindow *window=NULL, QDialog *parent=0) are not documented: parameter 'window'

I could not guess the meaning of that parameter.

TomFischer
TomFischer approved these changes Nov 29, 2016
View reviewed changes
Copy link
Member

@TomFischer TomFischer left a comment

Choose a reason for hiding this comment

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

👍

chleh
chleh reviewed Nov 29, 2016
View reviewed changes
scripts/jenkins/docs.groovy
@@ -25,6 +25,7 @@ stage('Reports (Docs)') {
keepAll: false, reportDir: 'build/docs', reportFiles: 'index.html',
reportName: 'Doxygen'])
step([$class: 'WarningsPublisher', canResolveRelativePaths: false,
messagesPattern: '.*ogs_file_.*,.*potential recursive class relation.*',
Copy link
Collaborator

Choose a reason for hiding this comment

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

Does .*ogs_file_.* ignore parameter documentation warnings? I thought, they should stay active.

Copy link
Member

Choose a reason for hiding this comment

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

They will become active end of this week, when ogs_file_param are all documented.

bilke added a commit to bilke/ogs that referenced this pull request Nov 29, 2016
@bilke
[Jenkins] Added Doxygen ignore of false positive cite errors.
6ea9b1f 
Is fixed in Doxygen 1.8.12.
In Docker we have 1.8.11.

See ufz#1585.
bilke added a commit to bilke/ogs that referenced this pull request Nov 29, 2016
@bilke
[Jenkins] Added Doxygen ignore of false positive cite errors.
ff0e03b 
Is fixed in Doxygen 1.8.12.
In Docker we have 1.8.11.

See ufz#1585.
@bilke
Copy link
Member Author

bilke commented Nov 29, 2016 •
edited
Loading

Done: Zero doxygen warnings in Jenkins.

Added changelog too.

@endJunction endJunction merged commit 6fd1bd1 into ufz:master Nov 29, 2016
@endJunction endJunction deleted the doxygen-parser branch November 29, 2016 15:59
@endJunction endJunction restored the doxygen-parser branch November 29, 2016 15:59
@bilke bilke deleted the doxygen-parser branch December 6, 2016 15:49
@ogsbot
Copy link
Member

ogsbot commented Jun 19, 2020

OpenGeoSys development has been moved to GitLab.

See this pull request on GitLab.

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

@chleh chleh chleh left review comments

@endJunction endJunction endJunction left review comments

@TomFischer TomFischer TomFischer approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@bilke @endJunction @ogsbot @TomFischer @chleh