[Enhancement] DocC documentation support #23

Merged

javier merged 14 commits from enhancement/documentation into main

2023-08-13 22:01:02 +00:00

javier commented

2023-08-13 21:59:32 +00:00

Owner

This PR contains the work done to add DocC support to all the libraries included in this package, as requested by issue #9.

To provide further details about the work done:

added the DocC plugin package as a dependency
improved the naming of the targets in the Package file
updated the README file
implemented the Xcode and Github pages documentation generation targets in the Makefile file
generated both Xcode and Github pages documentation

This PR contains the work done to add DocC support to all the libraries included in this package, as requested by issue #9. To provide further details about the work done: - [x] added the DocC plugin package as a dependency - [x] improved the naming of the targets in the Package file - [x] updated the README file - [x] implemented the Xcode and Github pages documentation generation targets in the Makefile file - [x] generated both Xcode and Github pages documentation

javier added the enhancement label 2023-08-13 21:59:32 +00:00

javier self-assigned this 2023-08-13 21:59:32 +00:00

javier added 13 commits 2023-08-13 21:59:33 +00:00

Renamed the Sources folder as Libraries. c29178535a

Updated the Package file to reflect the change in the folder structure, plus the libraries' target names have been renamed to avoid any possible ambiguity with any other 1st or 3rd party library. 5a8d3c0530

Updated the README file to the updated library names. 4ca0108a9c

Made a small tweak to the "tests" computed property of the String+Computed extension in the Package file. 683900afeb

Added the DocC plugin package dependency to the Package file. 5a7de24866

Implemented the "help-docc-plugin" target in the Makefile file. 1874d6ecec

Implemented the "generate-docs", "preview-doc", and "flush-docs" targets in the Makefile file. f701202933

Included the Package resolved file that declares the DocC plugin package dependencies. 7af3e1b9f5

Generated the Xcode and Github pages documentation. 4fc01fa20f

Implemented the Index HTML page generation into the "generate-docs" target in the Makefile file. e6e3612072

Regenerated the Xcode and Github pages documentation. 3c0a4d70aa

Regenerated the Xcode and Github pages documentation (yet again!). 94e20f3ca8

Regenerated the Xcode and Github pages documentation (yet yet again!). 31ed3bc784

javier added 1 commit 2023-08-13 22:00:48 +00:00

Merge branch 'main' into enhancement/documentation 1a6942ede4

* main:
  [Improvement] Naming of libraries and package (#22)

javier merged commit f7235cdd28 into main

2023-08-13 22:01:02 +00:00

javier deleted branch enhancement/documentation

2023-08-13 22:01:02 +00:00

javier referenced this issue from a commit

2023-08-13 22:01:03 +00:00

[Enhancement] DocC documentation support (#23)

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: rock-n-code/swift-libs#23