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

Added copyright notice to all .swift files (#391) #403

Merged
merged 3 commits into from
Mar 9, 2024
Merged

Added copyright notice to all .swift files (#391) #403

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1d400dc
Added copyright notice to all .swift files
Jag-Marcel Feb 28, 2024
110f1c7
Minor stylistic adjustment
Jag-Marcel Mar 4, 2024
6f90db1
Minor edits/fixes to file descriptions
andrewtavis Mar 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions Keyboards/InterfaceConstants.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
//
// Scribe
//
// Constants for Scribe keyboard interfaces.
//
/**
* Constants for the Scribe keyboard interfaces
*
*
* Copyright (C) 2023 Scribe
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey!! 👋

Just wondering about something here..
How would we plan on maintaining this license header in all the relevant files? Not sure if some automation was used to make the changes in this PR, but could there be something like .editorconfig that we could use to generate these (especially if we'd like to tweak the text in the future)?

CC: @andrewtavis

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any level of automation would be appreciated for this. I believe that @Jag-Marcel was going through individually as this was also a task of better understanding the codebase. The file headers also have a description of the file, which we thought was important. Could you send along an example of how the license could be automated with this, @wkyoshida?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like this might be possible with Xcode perhaps (ref)? I don't have Xcode to be able to validate if this works though..

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to be a bit more for changing the default for when the file is made, but maybe I'm not reading it clearly 🤔 Would be good to include though! I'd say it's a different issue though.

enum SpecialKeys {
static let indent = "indent"
Expand Down
24 changes: 19 additions & 5 deletions Keyboards/KeyboardsBase/Colors/ColorVariables.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
//
// ColorVariables.swift
//
// Variables associated with coloration for Scribe.
//
/**
* Variables associated with coloration for scribe
*
*
* Copyright (C) 2023 Scribe
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

import UIKit

Expand Down
22 changes: 19 additions & 3 deletions Keyboards/KeyboardsBase/Colors/ScribeColor.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,22 @@
//
// ScribeColor.swift
//
/**
* Converts strings for colors into the corresponding color
*
*
* Copyright (C) 2023 Scribe
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

import UIKit

Expand Down
22 changes: 19 additions & 3 deletions Keyboards/KeyboardsBase/Colors/UIColor+ScribeColors.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,22 @@
//
// UIColor+ScribeColors.swift
//
/**
* Adds Scribe colors to the UIColor pool
*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor change request on this, @Jag-Marcel, could we put a period at the end of all of the descriptions and just have one line after it instead of two?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure! I'll get on it

*
* Copyright (C) 2023 Scribe
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

import UIKit

Expand Down
24 changes: 19 additions & 5 deletions Keyboards/KeyboardsBase/Extensions.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
//
// Extensions.swift
//
// Extensions for Scribe keyboards.
//
/**
* Extensions for Scribe keyboards
*
*
* Copyright (C) 2023 Scribe
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

import UIKit

Expand Down
24 changes: 19 additions & 5 deletions Keyboards/KeyboardsBase/InterfaceVariables.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
//
// InterfaceVariables.swift
//
// Variables associated with the base keyboard interface.
//
/**
* Variables associated with the base keyboard interface
*
*
* Copyright (C) 2023 Scribe
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

import UIKit

Expand Down
24 changes: 19 additions & 5 deletions Keyboards/KeyboardsBase/KeyAltChars.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
//
// KeyAltChars.swift
//
// Functions and variables to create alternate key views.
//
/**
* Functions and variables to create alternate key views
*
*
* Copyright (C) 2023 Scribe
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

import UIKit

Expand Down
24 changes: 19 additions & 5 deletions Keyboards/KeyboardsBase/KeyAnimation.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
//
// KeyAnimation.swift
//
// Functions to animate key pressed with pop up characters.
//
/**
* Functions to animate key pressed with pop up characters
*
*
* Copyright (C) 2023 Scribe
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

import UIKit

Expand Down
24 changes: 19 additions & 5 deletions Keyboards/KeyboardsBase/KeyboardKeys.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
//
// KeyboardKey.swift
//
// Classes and variables that define keys for Scribe keyboards.
//
/**
* Classes and variables that define keys for Scribe keyboards
*
*
* Copyright (C) 2023 Scribe
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

import UIKit

Expand Down
24 changes: 19 additions & 5 deletions Keyboards/KeyboardsBase/KeyboardStyling.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
//
// KeyboardStyling.swift
//
// Functions to style keyboard elements.
//
/**
* Functions to style keyboard elements
*
*
* Copyright (C) 2023 Scribe
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

import UIKit

Expand Down
27 changes: 21 additions & 6 deletions Keyboards/KeyboardsBase/KeyboardViewController.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,24 @@
//
// KeyboardViewController.swift
//
// Classes for the parent keyboard view controller that language keyboards inherit and keyboard keys.
//

/**
* Classes for the parent keyboard view controller that language keyboards inherit and keyboard keys.
*
*
* Copyright (C) 2023 Scribe
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/


import GRDB
import UIKit

Expand Down
24 changes: 19 additions & 5 deletions Keyboards/KeyboardsBase/LoadData.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
//
// LoadData.swift
//
// Function for loading in data to the keyboards.
//
/**
* Function for loading in data to the keyboards
*
*
* Copyright (C) 2023 Scribe
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

import Foundation
import GRDB
Expand Down
24 changes: 19 additions & 5 deletions Keyboards/KeyboardsBase/ScribeFunctionality/Annotate.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
//
// Annotate.swift
//
// Functions and elements that control word annotations.
//
/**
* Functions and elements that control word annotations
*
*
* Copyright (C) 2023 Scribe
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

import UIKit

Expand Down
24 changes: 19 additions & 5 deletions Keyboards/KeyboardsBase/ScribeFunctionality/CommandBar.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
//
// CommandBar.swift
//
// Class defining the bar into which commands are typed.
//
/**
* Class defining the bar into which commands are typed
*
*
* Copyright (C) 2023 Scribe
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

import UIKit

Expand Down
Loading
Loading