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

Link documentation #24

Closed
mariomastrodicasa opened this issue Feb 21, 2022 · 4 comments · Fixed by #202, #210, #393 or #394
Closed

Link documentation #24

mariomastrodicasa opened this issue Feb 21, 2022 · 4 comments · Fixed by #202, #210, #393 or #394
Assignees
@masesdevelopers
Labels
documentation Improvements or additions to documentation enhancement New feature or request KNet KNet related issue

Comments

@mariomastrodicasa
Copy link
Contributor

Is your feature request related to a problem? Please describe.
The documentation available on website under docs folder does not have any reference to the official Apache Kafka Javadocs.

Describe the solution you'd like
Try to find a solution to cross-link the documentation.

Describe alternatives you've considered
N/A

Additional context
N/A
@mariomastrodicasa mariomastrodicasa added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 21, 2022
@masesdevelopers masesdevelopers added the KNet KNet related issue label Oct 25, 2022
@masesdevelopers
Copy link
Contributor

First version of JNet Reflector (see masesgroup/JNet#45) comes with an initial stub of code generation which links the documentation. When the tool will cover more features the documentation can be created using an automatic tool.

@masesdevelopers masesdevelopers mentioned this issue Mar 13, 2023
Closed
@masesdevelopers masesdevelopers mentioned this issue Jul 7, 2023
Merged
9 tasks
masesdevelopers added a commit that referenced this issue Jul 7, 2023
@masesdevelopers
Added missing documentation (#194)
916309e 
* #24, #168: review documentation, removed unused classes, KafkaClientSupplier becomes a listener
@masesdevelopers masesdevelopers mentioned this issue Jul 7, 2023
Merged
9 tasks
masesdevelopers added a commit that referenced this issue Jul 7, 2023
@masesdevelopers
#24: fix documentation location (#195)
3a72d04
@masesdevelopers
Copy link
Contributor

Many warning are raised because the following line report

KNet/src/net/KNet/Generated/Kafka/Admin/DeleteRecordsCommand.cs

Line 48 in 3a72d04

/// <param name="out"><see cref="Java.Io.PrintStream"/></param>
while the parameter is

KNet/src/net/KNet/Generated/Kafka/Admin/DeleteRecordsCommand.cs

Line 49 in 3a72d04

public static void Execute(string[] args, Java.Io.PrintStream _out)

The worst case happens for parameters like

KNet/src/net/KNet/Generated/Kafka/Admin/BrokerMetadata.cs

Line 55 in 3a72d04

/// <param name="x$1"><see cref="object"/></param>
it contains $

@masesdevelopers masesdevelopers mentioned this issue Jul 7, 2023
Closed
masesdevelopers added a commit that referenced this issue Jul 7, 2023
@masesdevelopers
#24: removed many warning from workflows output (#196)
57775eb
masesdevelopers added a commit that referenced this issue Jul 7, 2023
@masesdevelopers
#24: added disclaimer for version 2.0.0 (#197)
cb755ee
masesdevelopers added a commit that referenced this issue Jul 7, 2023
@masesdevelopers
#24: added some documentation for serializer/deserializer (#201)
b9e9db3
@masesdevelopers masesdevelopers mentioned this issue Jul 7, 2023
Merged
9 tasks
masesdevelopers added a commit that referenced this issue Jul 7, 2023
@masesdevelopers @github-actions
Merge version v2.0.0 (#202)
f094736 
* Full project review based on latest version of JNet suite (#193)

* #168: first step: replace namespaces in all available classes

* #93: documentation alignment

* Added a benchmark to verify performance roundtrip (#178)

* #53: added new roundtrip benchmark

* #53: update performance description file

* #168: moved KNet specific classes into dedicated folder

* #179: fixed compacted topic creation (#180)

* #92: full class review due to breaking change in JCOBridge

* #168: first generation

* Added KNetCompactedReplicator, evolved KNetProducer and KNetConsumer, enhanced serializer/deserializer (#182)

* #92: full class review due to breaking change in JCOBridge

* #175: improvements in Consumer/Producer Builders

* #175: review classes to accept new KNetCompactedReplicator

* #175: added serialization projects

* #175: moved to Java SerDes due to error in C# compilation within container

* #175: review of KNetConsumer, KNetProducer and KNetSerDes; added specific test for KNetConsumer and KNetProducer

* #175: update serialization and added MessagePack type

* #175: updates on sync management

* #175: documentation update

* Update documentation after commit fb2bded

* Added missing SourceLink

* Configuration is now managed using a JSON file (masesgroup/JNet#179)

* Update configuration and files

* Temporary commit: many classes shall be removed because are old

* #185: fix .NET Framework PowerShell version (#186)

* #92: update to JNet 2.0.0.0

* #121: update to version 2.0.0.0

* Correction on namespace

* Update classes after JNetReflector update for masesgroup/JNet#195

* #168 (comment): implementation of special listeners

* Reviewed implementation of KNet version of ConnectStandalone and ConnectDistributed

* #88: full update to Apache Kafka 3.5.0

* Code alignment to latest JNetReflector: nullable native types converted into Java types

* Update workflows to avoid documentation generation out of main branch build

* Update documentation after commit 312b4bf

* Added missing documentation (#194)

* #24, #168: review documentation, removed unused classes, KafkaClientSupplier becomes a listener

* #24: fix documentation location (#195)

* #24: removed many warning from workflows output (#196)

* #24: added disclaimer for version 2.0.0 (#197)

* Update documentation after commit cb755ee

* V2 merge conflicts solved (#198)

* Remerge (#199)

* #24: added some documentation for serializer/deserializer (#201)

* Update documentation after commit b9e9db3

---------

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
@masesdevelopers
Copy link
Contributor

#24 (comment) still not closed, reopen issue

@masesdevelopers masesdevelopers mentioned this issue Jul 11, 2023
Merged
9 tasks
masesdevelopers added a commit that referenced this issue Jul 11, 2023
@masesdevelopers
#24 (comment): updates files with warning removal (#210)
77b5b5b
@masesdevelopers
Copy link
Contributor

Use xrefmap from JNet in docfx.json

@masesdevelopers masesdevelopers mentioned this issue Jan 27, 2024
Merged
9 tasks
@masesdevelopers masesdevelopers mentioned this issue Jan 27, 2024
Merged
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@masesdevelopers masesdevelopers

Labels
documentation Improvements or additions to documentation enhancement New feature or request KNet KNet related issue
Projects
None yet
Milestone
No milestone
2 participants
@mariomastrodicasa @masesdevelopers