Comments (5)
Do you mean `Version.swift` in SwiftDocC repo?
The SymbolKit seems solved it in `SemanticVersion.swift`
/**
* The major version number.
*
* For example, the `1` in `1.2.3`
*/
public var major: Int
/**
* The minor version number.
*
* For example, the `2` in `1.2.3`
*/
public var minor: Int
/**
* The patch version number.
*
* For example, the `3` in `1.2.3`
*/
public var patch: Int
/// The optional prerelease version component, which may contain non-numeric characters.
///
/// For example, the `4` in `1.2.3-4`.
public var prerelease: String?
/// Optional build metadata.
public var buildMetadata: String?
from swift-docc.
There are other version formats that we may want to support, especially for non-framework targets, so we may want to be even less strict about the version information and allow any string value.
That said, the version information isn’t currently used anywhere so we could also remove it now and add it back in the future when we have a need for that information.
from swift-docc.
> Do you mean `Version.swift` in SwiftDocC repo?
Right yeah. That seems to be what is used when we invoke.
SwiftPM also has a good semantic version type you're free to use believe https://github.com/apple/swift-tools-support-core/blob/main/Sources/TSCUtility/Version.swift (Checked with Boris from SwiftPM team)
from swift-docc.
> That said, the version information isn’t currently used anywhere so we could also remove it now and add it back in the future when we have a need for that information.
I mean, the docc page should definitely show what version of a package is documented, so I don't think removal is an option really.
from swift-docc.
I opened a PR here that keeps the version information but removes the requirements that it's formatted a specific way. #49
That way it could be presented somewhere while still giving developers the full flexibility to use any version format that they prefer.
from swift-docc.
Related Issues (20)
- Typealiased type are not reflected properly in the documentation HOT 4
- Reenable DefaultDiagnosticConsoleFormatter HOT 1
- Crash when building locally HOT 4
- Duplicated diagnostic causing crash on DefaultDiagnosticConsoleFormatter HOT 8
- Overly strict warning when curating a module under a technology root HOT 19
- Line numbers in code listings HOT 3
- The wrong role is assigned to the technology-root node in article-only catalogs
- Any way to merge the index.json for multiple framework hosting on single Static site ? HOT 8
- Provide `@Embed` directive as an equivalent of HTML <embed/> or <iframe/>
- Swift-DocC should display C++ and Objective-C++ as their own source languages
- Sitemap for DocC Hosted Website HOT 4
- source link line number mismatch HOT 2
- Support svg images in Xcode inline documentation HOT 2
- Pass "link summaries" instead of "resolved information" in external documentation source responses
- Can't document - -= / /= operators HOT 8
- DocC generates inconsistent output for global Objective-C functions that are renamed to be associated with a type in Swift HOT 2
- Error when publishing to GitHub Pages HOT 6
- Linkable glossary
- Document Objective-C extensions with DocC HOT 2
- Doc Comments Are Ignored for Macros HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from swift-docc.