Browse Source

! code documentation

Spuds 12 years ago
parent
commit
eae5254c9f
3 changed files with 22 additions and 5 deletions
  1. 15 2
      Sources/MoveTopic.php
  2. 6 2
      Sources/Subs-Graphics.php
  3. 1 1
      Sources/Topic.php

+ 15 - 2
Sources/MoveTopic.php

@@ -1,6 +1,9 @@
 <?php
 
 /**
+ * This file contains the functions required to move topics from one board to
+ * another board.
+ *
  * Simple Machines Forum (SMF)
  *
  * @package SMF
@@ -68,7 +71,7 @@ function MoveTopic()
 		isAllowedTo('approve_posts');
 
 	// Permission check!
-	// !!!
+	// @todo
 	if (!allowedTo('move_any'))
 	{
 		if ($id_member_started == $user_info['id'])
@@ -146,7 +149,17 @@ function MoveTopic()
 	checkSubmitOnce('register');
 }
 
-// Execute the move.
+/**
+ * Execute the move of a topic.
+ * It is called on the submit of MoveTopic.
+ * This function logs that topics have been moved in the moderation log.
+ * If the member is the topic starter requires the move_own permission,
+ * otherwise requires the move_any permission.
+ * Upon successful completion redirects to message index.
+ * Accessed via ?action=movetopic2.
+ *
+ * @uses Subs-Post.php.
+ */
 function MoveTopic2()
 {
 	global $txt, $board, $topic, $scripturl, $sourcedir, $modSettings, $context;

+ 6 - 2
Sources/Subs-Graphics.php

@@ -1,6 +1,12 @@
 <?php
 
 /**
+ * This file deals with low-level graphics operations performed on images,
+ * specially as needed for avatars (uploaded avatars), and attachments.
+ * It uses, for gifs at least, Gif Util... for more information on that,
+ * please see its website.
+ * TrueType fonts supplied by www.LarabieFonts.com
+ *
  * Simple Machines Forum (SMF)
  *
  * @package SMF
@@ -11,8 +17,6 @@
  * @version 2.0
  */
 
-// TrueType fonts supplied by www.LarabieFonts.com
-
 if (!defined('SMF'))
 	die('Hacking attempt...');
 

+ 1 - 1
Sources/Topic.php

@@ -2,7 +2,7 @@
 
 /**
  * This file takes care of actions on topics:
- * locking and sticky-ing.
+ * lock/unlock a topic, sticky/unsticky it,
  *
  * Simple Machines Forum (SMF)
  *