Skip to content

Commit 90c5e91

Browse files
author
Deren Vural
committed
Updated comment headers for classes+functions+traits+files to use /**, for rustdoc
Signed-off-by: Deren Vural <[email protected]>
1 parent 8c399ac commit 90c5e91

File tree

17 files changed

+132
-100
lines changed

17 files changed

+132
-100
lines changed

‎build.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// SPDX-FileCopyrightText: 2022 Deren Vural
22
// SPDX-License-Identifier: GPL-3.0-or-later
33

4-
/*
4+
/**
55
* Name:
66
* build.rs
77
*
@@ -25,7 +25,7 @@
2525
// Imports
2626
use adwaita::gio::compile_resources;
2727

28-
/*
28+
/**
2929
* Name:
3030
* main
3131
*

‎src/custom_button/imp.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// SPDX-FileCopyrightText: 2022 Deren Vural
22
// SPDX-License-Identifier: GPL-3.0-or-later
33

4-
/*
4+
/**
55
* Name:
66
* imp.rs
77
*

‎src/custom_button/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// SPDX-FileCopyrightText: 2022 Deren Vural
22
// SPDX-License-Identifier: GPL-3.0-or-later
33

4-
/*
4+
/**
55
* Name:
66
* mod.rs
77
*

‎src/formatter/imp.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// SPDX-FileCopyrightText: 2022 Deren Vural
22
// SPDX-License-Identifier: GPL-3.0-or-later
33

4-
/*
4+
/**
55
* Name:
66
* imp.rs
77
*
@@ -40,7 +40,7 @@ impl ObjectSubclass for Formatter {
4040
type ParentType = gtk::Widget;
4141
}
4242

43-
/*
43+
/**
4444
* Trait Name:
4545
* ObjectImpl
4646
*
@@ -57,7 +57,7 @@ impl ObjectSubclass for Formatter {
5757
*
5858
*/
5959
impl ObjectImpl for Formatter {
60-
/*
60+
/**
6161
* Name:
6262
* properties
6363
*
@@ -94,7 +94,7 @@ impl ObjectImpl for Formatter {
9494
PROPERTIES.as_ref()
9595
}
9696

97-
/*
97+
/**
9898
* Name:
9999
* set_property
100100
*
@@ -119,7 +119,7 @@ impl ObjectImpl for Formatter {
119119
}
120120
}
121121

122-
/*
122+
/**
123123
* Name:
124124
* property
125125
*
@@ -145,7 +145,7 @@ impl ObjectImpl for Formatter {
145145
}
146146
}
147147

148-
/*
148+
/**
149149
* Trait Name:
150150
* WidgetImpl
151151
*

‎src/formatter/mod.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// SPDX-FileCopyrightText: 2022 Deren Vural
22
// SPDX-License-Identifier: GPL-3.0-or-later
33

4-
/*
4+
/**
55
* Name:
66
* mod.rs
77
*
@@ -35,7 +35,7 @@ glib::wrapper! {
3535
@implements gtk::Accessible, gtk::Actionable, gtk::Buildable, gtk::ConstraintTarget;
3636
}
3737

38-
/*
38+
/**
3939
* Trait Name:
4040
* Formatter
4141
*
@@ -52,7 +52,7 @@ glib::wrapper! {
5252
*
5353
*/
5454
impl Formatter {
55-
/*
55+
/**
5656
* Name:
5757
* new
5858
*
@@ -118,7 +118,7 @@ impl Formatter {
118118
}
119119
}
120120

121-
/*
121+
/**
122122
* Trait Name:
123123
* Default
124124
*

‎src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// SPDX-FileCopyrightText: 2022 Deren Vural
22
// SPDX-License-Identifier: GPL-3.0-or-later
33

4-
/*
4+
/**
55
* Name:
66
* main.rs
77
*

‎src/mainwindow/imp.rs

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// SPDX-FileCopyrightText: 2022 Deren Vural
22
// SPDX-License-Identifier: GPL-3.0-or-later
33

4-
/*
4+
/**
55
* Name:
66
* imp.rs
77
*
@@ -70,7 +70,7 @@ impl ObjectSubclass for MainWindow {
7070
}
7171
}
7272

73-
/*
73+
/**
7474
* Name:
7575
* MainWindow
7676
*
@@ -88,7 +88,7 @@ impl ObjectSubclass for MainWindow {
8888
*/
8989
#[gtk::template_callbacks]
9090
impl MainWindow {
91-
/*
91+
/**
9292
* Name:
9393
* update_setting
9494
*
@@ -117,7 +117,7 @@ impl MainWindow {
117117
}
118118
}
119119

120-
/*
120+
/**
121121
* Name:
122122
* get_setting
123123
*
@@ -143,7 +143,7 @@ impl MainWindow {
143143
}
144144
}
145145

146-
/*
146+
/**
147147
* Name:
148148
* card_selected
149149
*
@@ -189,7 +189,7 @@ impl MainWindow {
189189
*/
190190
}
191191

192-
/*
192+
/**
193193
* Name:
194194
* create_provider
195195
*
@@ -435,7 +435,7 @@ impl MainWindow {
435435

436436

437437

438-
/*
438+
/**
439439
* Name:
440440
* refresh_cards
441441
*
@@ -599,7 +599,7 @@ impl MainWindow {
599599
}
600600
}
601601
}
602-
/*
602+
/**
603603
* Trait Name:
604604
* ObjectImpl
605605
*
@@ -616,6 +616,22 @@ impl MainWindow {
616616
*
617617
*/
618618
impl ObjectImpl for MainWindow {
619+
/**
620+
* Name:
621+
* constructed
622+
*
623+
* Description:
624+
* Called during construction, allows calling setup functions
625+
*
626+
* Made:
627+
* 09/10/2022
628+
*
629+
* Made by:
630+
* Deren Vural
631+
*
632+
* Notes:
633+
*
634+
*/
619635
fn constructed(&self, obj: &Self::Type) {
620636
// Call "constructed" on parent
621637
self.parent_constructed(obj);
@@ -628,7 +644,7 @@ impl ObjectImpl for MainWindow {
628644
obj.setup_actions();
629645
}
630646

631-
/*
647+
/**
632648
* Name:
633649
* properties
634650
*
@@ -665,7 +681,7 @@ impl ObjectImpl for MainWindow {
665681
PROPERTIES.as_ref()
666682
}
667683

668-
/*
684+
/**
669685
* Name:
670686
* set_property
671687
*
@@ -695,7 +711,7 @@ impl ObjectImpl for MainWindow {
695711
}
696712
}
697713

698-
/*
714+
/**
699715
* Name:
700716
* property
701717
*
@@ -728,7 +744,7 @@ impl ObjectImpl for MainWindow {
728744
}
729745
}
730746

731-
/*
747+
/**
732748
* Trait Name:
733749
* WidgetImpl
734750
*
@@ -746,7 +762,7 @@ impl ObjectImpl for MainWindow {
746762
*/
747763
impl WidgetImpl for MainWindow {}
748764

749-
/*
765+
/**
750766
* Trait Name:
751767
* WindowImpl
752768
*
@@ -789,7 +805,7 @@ impl WindowImpl for MainWindow {
789805
}
790806
}
791807

792-
/*
808+
/**
793809
* Trait Name:
794810
* AdwWindowImpl
795811
*
@@ -807,7 +823,7 @@ impl WindowImpl for MainWindow {
807823
*/
808824
impl AdwWindowImpl for MainWindow {}
809825

810-
/*
826+
/**
811827
* Trait Name:
812828
* ApplicationWindowImpl
813829
*
@@ -825,7 +841,7 @@ impl AdwWindowImpl for MainWindow {}
825841
*/
826842
impl ApplicationWindowImpl for MainWindow {}
827843

828-
/*
844+
/**
829845
* Trait Name:
830846
* AdwApplicationWindowImpl
831847
*

‎src/mainwindow/mod.rs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// SPDX-FileCopyrightText: 2022 Deren Vural
22
// SPDX-License-Identifier: GPL-3.0-or-later
33

4-
/*
4+
/**
55
* Name:
66
* mod.rs
77
*
@@ -39,7 +39,7 @@ glib::wrapper! {
3939
gtk::ConstraintTarget, gtk::Native, gtk::Root, gtk::ShortcutManager;
4040
}
4141

42-
/*
42+
/**
4343
* Trait Name:
4444
* MainWindow
4545
*
@@ -56,7 +56,7 @@ glib::wrapper! {
5656
*
5757
*/
5858
impl MainWindow {
59-
/*
59+
/**
6060
* Name:
6161
* new
6262
*
@@ -76,7 +76,7 @@ impl MainWindow {
7676
Object::new(&[("application", app)]).expect("`MainWindow` should be instantiable.")
7777
}
7878

79-
/*
79+
/**
8080
* Name:
8181
* setup_settings
8282
*
@@ -100,7 +100,7 @@ impl MainWindow {
100100
.expect("`settings` should not be set before calling `setup_settings`.");
101101
}
102102

103-
/*
103+
/**
104104
* Name:
105105
* settings
106106
*
@@ -123,7 +123,7 @@ impl MainWindow {
123123
.expect("`settings` should be set in `setup_settings`.")
124124
}
125125

126-
/*
126+
/**
127127
* Name:
128128
* setup_widgets
129129
*
@@ -143,7 +143,7 @@ impl MainWindow {
143143
//
144144
}
145145

146-
/*
146+
/**
147147
* Name:
148148
* restore_data
149149
*
@@ -179,7 +179,7 @@ impl MainWindow {
179179
*/
180180
}
181181

182-
/*
182+
/**
183183
* Name:
184184
* setup_callbacks
185185
*
@@ -213,7 +213,7 @@ impl MainWindow {
213213
*/
214214
}
215215

216-
/*
216+
/**
217217
* Name:
218218
* setup_actions
219219
*

0 commit comments

Comments
 (0)