Upgrading

From 1.x and older to 2.x

The biggest difference is that in 2.x, sources sets are used for configurations. Tasks are now longer configured directly.

If you 1.x configuration looks like this

doxygen {
    option 'generate_html', true

    sources new File(projectDir,'src/main/cpp')
    sources new File(projectDir,'src/main/headers')
}

then change is to look like this

doxygen {
  sourceSets {
    main {
        option 'generate_html', true

        sources new File(projectDir,'src/main/cpp')
        sources new File(projectDir,'src/main/headers')
    }
  }
}

DSL keywords such as image_paths are no longer used. The correct way is to use imagePaths. THus if you had

doxygen {
  image_paths 'src/images'
}

it now needs to be

doxygen {
  sourceSets {
    main {
        imagePaths 'src/images'
    }
  }
}

the main task is now called doxygenDox and not doxygen. However, due to Gradle’s way of resolving shorted tasks names that are unambigious, there is a good chance that just supplying doxygen on the command-line will still work for you.