Skip to content

Commit acb9a03

Browse files
committed
add javadoc jar
1 parent aade0b8 commit acb9a03

File tree

5 files changed

+28
-1
lines changed

5 files changed

+28
-1
lines changed

allure-java-commons/src/main/java/io/qameta/allure/Attachment.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,24 @@
1616
public @interface Attachment {
1717

1818
/**
19-
* Attachment name.
19+
* The attachment name.
20+
*
21+
* @return the attachment name.
2022
*/
2123
String value() default "{method}";
2224

2325
/**
2426
* Valid attachment MimeType, for example "text/plain" or "application/json".
27+
*
28+
* @return the attachment type.
2529
*/
2630
String type() default "";
2731

2832
/**
2933
* Optional attachment file extension. By default file extension will be determined by
3034
* provided media type. Should be started with dot.
35+
*
36+
* @return the attachment file extension.
3137
*/
3238
String fileExtension() default "";
3339
}

allure-java-commons/src/main/java/io/qameta/allure/Link.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,22 +26,30 @@
2626

2727
/**
2828
* Alias for {@link #name()}.
29+
*
30+
* @return the link name.
2931
*/
3032
String value() default "";
3133

3234
/**
3335
* Name for link, by default url.
36+
*
37+
* @return the link name.
3438
*/
3539
String name() default "";
3640

3741
/**
3842
* Url for link. By default will search for system property `allure.link.{type}.pattern`, and use it
3943
* to generate url.
44+
*
45+
* @return the link url.
4046
*/
4147
String url() default "";
4248

4349
/**
4450
* This type is used for create an icon for link. Also there is few reserved types such as issue and tms.
51+
*
52+
* @return the link type.
4553
*/
4654
String type() default "custom";
4755
}

allure-java-commons/src/main/java/io/qameta/allure/aspects/AttachmentsAspects.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ public static AllureLifecycle getLifecycle() {
3232

3333
/**
3434
* Sets lifecycle for aspects. Usually used in tests.
35+
*
36+
* @param lifecycle allure lifecycle to set.
3537
*/
3638
public static void setLifecycle(final AllureLifecycle lifecycle) {
3739
AttachmentsAspects.lifecycle = lifecycle;
@@ -56,6 +58,9 @@ public void anyMethod() {
5658
/**
5759
* Process data returned from method annotated with {@link Attachment}.
5860
* If returned data is not a byte array, then use toString() method, and get bytes from it.
61+
*
62+
* @param joinPoint the join point to process.
63+
* @param result the returned value.
5964
*/
6065
@AfterReturning(pointcut = "anyMethod() && withAttachmentAnnotation()", returning = "result")
6166
public void attachment(final JoinPoint joinPoint, final Object result) {

allure-java-commons/src/main/java/io/qameta/allure/aspects/StepsAspects.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ public void stepStop() {
6767

6868
/**
6969
* For tests only.
70+
*
71+
* @param allure allure lifecycle to set.
7072
*/
7173
public static void setLifecycle(final AllureLifecycle allure) {
7274
lifecycle = allure;

build.gradle

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,14 @@ subprojects { project ->
6565
from sourceSets.main.allJava
6666
}
6767

68+
task javadocJar(type: Jar, dependsOn: javadoc) {
69+
classifier = 'javadoc'
70+
from javadoc.destinationDir
71+
}
72+
6873
artifacts {
6974
archives sourceJar
75+
archives javadocJar
7076
}
7177

7278
repositories {

0 commit comments

Comments
 (0)