Tag: Documentation

It's rainy here in California (which is unusual...) and our weekend is perfect to spend some time reading technical articles. Let's go.

• Paul Hudson makes great review of Swift 5.8 new features – What's new in Swift 5.8;
  
  
• Pimp My DocC Documentation by Marco Eidinger is a nice review of DocC customizations available in Swift 5.8;
  
  
• Quick tip by Natascha Fadeeva on simplifying test for nil in tests – Quick tip on how to unit test Swift optionals with XCTUnwrap;
  
  
• SwiftUI Tables Quick Guide by Keith Harrison covers work with tables in SwiftUI by macOS;
  
  
• Equatable in Swift could be implemented manually or synthesized automatically, go into details with article by Antoine van der Lee – Equatable conformance in Swift explained with code examples;
  
  
• Slightly less technical article, but still very important for engineers – How to avoid burnout as a software engineer? by Krzysztof Zabłocki;
  
  
• SwiftUI app lifecycle does not come with launch storyboard, how to deal with that – How to add Launch Screen in SwiftUI by Sarun W.;
  
  
• Sarah Reichelt shares open source project for a real life – To-Day;
  
  
• Supporting multiple iOS versions is hard, Leonardo Maia Pugliese proves that – How to Change the Background Color of Navigation Bars in all iOS versions?;
  
  
• Non-nominal types workaround for domain modeling by Alejandro Martinez is great exploratory article on working with types in Swift.

And one more thing. Apple Treats podcast is back with new episode. Our guest is Natalia Panferova whose articles you've already read.

https://www.youtube.com/watch?v=dLcF_fxErRw

Spring is coming, and we're continuing our tradition of weekend reads. Let's see what we've got for this week.

• Matej Bukovinski goes through SDK development with Swift – Swift's Approach to SPI;
  
  
• Couple of great articles from David Smith – some trigonometry in Learning from my Mistakes, review of apps and tools for developers – Indispensable Tools and approach to accessibility – Accessibility: Try, then Listen;
  
  
• Automate debugging SwiftUI and UIKit with dataTile by Marin Todorov explains view debugging techniques with new dataTile tool;
  
  
• Sarun W. covers new approach to manage subscriptions – Allow users to manage In-App Subscription in SwiftUI;
  
  
• New passkeys are explained in Developer guide on passkeys for iOS by Natascha Fadeeva;
  
  
• John Sundell helps to distinguish views and view modifiers in SwiftUI – SwiftUI views versus modifiers;
  
  
• Interestingly, similar topic is covered in View Composition using ViewModifiers in SwiftUI by Antoine van der Lee;
  
  
• Improve code documentation with The visual reference guide for documenting your Swift code by Marco Eidinger;
  
  
• Good hint on error pattern matching by Ole Begemann – Pattern matching on error codes;
  
  
• Majid Jabrayilov continues series on charts in SwiftUI with accessibility – Mastering charts in SwiftUI. Accessibility.;
  
  
• Lee Kah Seng dives into configurable widgets in How to Create Configurable Widgets With Dynamic Options?;
  
  
• Setting Up Different Environments in SwiftUI: Command Line Arguments and Build Configurations by Leonardo Maia Pugliese explains work with various build and execution options in SwiftUI;
  
  
• Michael Tsai comments on new way to wire outlets – NSViewController.ViewLoading.

And that is it for today. Have some rest and get back next week.

Swift team announces that The Swift Programming Language is now published using Swift-DocC documentation compiler.

This is a significant milestone for the DocC documentation tool.

This is a major step for the book. It was first open-sourced in August 2022 and since then, we’ve merged over 50 pull requests as we converted to DocC. We also made enhancements to DocC based on what we learned working on the book, like adding control over automatic see-also sections and new on-page navigation. Other DocC content that guides developers through a linear narrative, like the documentation for large or complex packages, can also take advantage of these enhancements.

Swift team

DocC project is open-source and open for contribution.

GitHub: Swift-DocC

Swift Docs: The Swift Programming Language

Reference: “The Swift Programming Language” book now published with DocC

It's Christmas weekend, and to give you time to celebrate, we've made slightly smaller list of articles. But those are really good.

• Peter Tretyakov is back with Code Signing Hell with XCFramework (by the way, he hinted that ChatGPT actually helped him to improve readability of the article);
  
  
• David Smith continues his design notes diary – DND 11: Better Dynamic Type Designs and DND 12: Sparkle Magic;
  
  
• How to Create an iOS Lock Screen Widget? by Lee Kah Seng explores use of WidgetKit for Lock Screen widgets;
  
  
• Moritz Philip Recke provides a guide on DocC usage on GitHub Pages – Configuring the Hosting Base Path in Xcode to Publish DocC Documentation on GitHub Pages;
  
  
• How to perform a lightweight migration in Core Data by Natascha Fadeeva guides through simple but important process working with Core Data;
  
  
• Leonardo Maia Pugliese explains new concurrency usage in SwiftUI – Efficiently Managing Multiple Async Tasks in SwiftUI.

And that is it for today. Merry Christmas and happy holidays!

While we're in the midst between iOS and iPadOS releases, we have couple of things to read during the release.

• Jordan Morgan provides overview of new concurrency model with completion handlers – Use Swift Concurrency with Completion Handlers;
  
  
• Leonardo Maia Pugliese provides developer productivity tips in Save Time With User Breakpoints in Xcode;
  
  
• iOS developer guide on the main aspects of Core Data by Natascha Fadeeva provides great overview on Core Data;
  
  
• Sarun W. covers SwiftUI view positioning in SwiftUI zIndex: Everything you need to know and also talks about view cycle in viewDidLoad() in SwiftUI;
  
  
• Aspect Fit Layout Guide by Keith Harrison explores UIKit layout engine;
  
  
• Antoine van der Lee explains typical concurrency issues in Deadlocks in Swift explained: detecting and solving;
  
  
• Majid Jabrayilov explains new Live Activities API in Displaying live activities in iOS 16;
  
  
• DocC Tutorial for Swift : Getting Started by Mina H. Gerges provides great overview of Apple's documentation tool.

And that is it. Have some rest, probably play with new shiny Apple Watch Ultra and come over next weekend for new articles.

New guides are now available on Swift portal. Guides include environment setup, building, testing, debugging and optimizations and many other topics.

Swift.org: Swift on Server Guides

Reference: Server Guides Now on Swift.org

Swift community starts efforts on improving Swift documentation.

Blog post highlights main goals:

• Guide development for documentation tooling such as Swift-DocC to benefit the entire ecosystem
• Define processes that govern contributions to documentation tooling

Swift.org: Swift Documentation Workgroup charter

Swift Blog: Announcing the Documentation Workgroup

Long time no see. Let's get back with good reads for the weekend before WWDC22. Monday will give us much more news for the next year, but today let's take a look on couple of interesting articles.

• Some important thing regarding usage of enumerated() worth repeating – Avoiding Swift’s enumerated() by Michael Tsai;
  
  
• Transitions in SwiftUI by Chris Eidhof digs into transition animations in SwiftUI;
  
  
• Using DocC on GitHub Pages: Pros and Cons by Jesse Squires might help open source developers to adopt DocC for project documentation;
  
  
• Couple of great articles by Ole Begemann – A heterogeneous dictionary with strong types in Swift, AttributedString’s Codable format and what it has to do with Unicode and How @MainActor works;
  
  
• Daniel Jalkut covers interesting topic of menu bar integration in macOS – Designing macOS Menu Bar Extras;
  
  
• Wordle game implementation in two parts by Bill Morefield – How to Make a Game Like Wordle in SwiftUI: Part One and How to Make a Game Like Wordle in SwiftUI: Part Two;
  
  
• Server-side Swift gets more and more attention lately, Jari Koopman gives good introduction in Introduction to Metrics in Server-Side Swift;
  
  
• iOS Accessibility in SwiftUI: Create Accessible Charts using Audio Graphs by David Piper covers new accessibility features in iOS 15 (expect new articles soon for features planned for next release);
  
  
• Majid Jabrayilov published several great articles on logging and performance analysis: Logging in Swift, Exporting data from Unified Logging System in Swift, Measuring app performance in Swift, Modeling errors in Swift and SwiftUI-related – Mastering TimelineView in SwiftUI, The power of accessibilityChildren view modifier in SwiftUI;
  
  
• Using private API is prohibited... but... Calling Private APIs in iOS by Jordan Morgan will cover this topic, if that is truly necessary;
  
  
• Also, SwiftUI hints by Jordan Morgan – Send Events from SwiftUI to UIKit and Vice Versa and Handle Keyboard Presses Using SwiftUI in macOS;
  
  
• Some testing hints by Natascha Fadeeva – Testing remote iOS push notifications in a simulator with simctl and Getting started with UI testing for SwiftUI.

That's it for this weekend. Next week will be quite packed with things to read and watch!

It’s Friday, it’s time for a new pack of articles to go over the weekend.

Android and Figma Typography and how to achieve 100% fidelity

Please read this article carefully if your app designs are created in Figma. Autor describes how Compose text rendering will soon match those designs exactly.

Documenting Kotlin Code for Android Using KDoc and Dokka

Article about how to use KDoc to document your Kotlin code and generate beautiful-looking documentation pages using Dokka.

Kotlin Flow Buffer is like A Fashion Adoption

Kotlin Flow provides 3 different ways to buffer values, they are Buffer, Conflate, CollectLatest. Although the idea behind each of them is similar, the principles of operation are different. This article illustrates these differences.

Stabilize, Modularize, Modernize: Scaling Slack’s Mobile Codebases

Project modularization is not the easiest task. It is good to watch how others do it and learn from their mistakes and successes. This article is a good source of information for us.

That’s all from us, be safe!

Apple promised to open source DocC. And now Swift team announces that documentation compiler becomes Swift open source project.

Developers now could contribute to DocC and also request new features via Swift JIRA.

Project depends on several related projects:

• SymbolKit is a Swift package containing the specification and reference model for the Symbol Graph File Format.
• Swift Markdown is a Swift package for parsing, building, editing, and analyzing Markdown documents. It includes support for the Block Directive elements that Swift-DocC's tutorial files rely on.
• Swift-DocC-Render is a web application that understands and renders Swift-DocC's render JSON format.